Changelog¤
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Changelog¤
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Contributor Covenant Code of Conduct¤
Our Pledge¤
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Our Standards¤
Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Enforcement Responsibilities¤
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
Scope¤
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Enforcement¤
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at pawamoy@pm.me. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Enforcement Guidelines¤
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
1. Correction¤
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
2. Warning¤
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
3. Temporary Ban¤
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
4. Permanent Ban¤
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
Attribution¤
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
Contributor Covenant Code of Conduct¤
Our Pledge¤
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Our Standards¤
Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Enforcement Responsibilities¤
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
Scope¤
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Enforcement¤
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dev@pawamoy.fr. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Enforcement Guidelines¤
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
1. Correction¤
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
2. Warning¤
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
3. Temporary Ban¤
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
4. Permanent Ban¤
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
Attribution¤
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
Contributing¤
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Environment setup¤
Nothing easier!
Fork and clone the repository, then:
cd markdown-pycon
+ Contributing - Markdown PyCon Contributing¤
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Environment setup¤
Nothing easier!
Fork and clone the repository, then:
cd markdown-pycon
make setup
-
Note
If it fails for some reason, you'll need to install PDM manually.
You can install it with:
python3 -m pip install --user pipx
-pipx install pdm
-
Now you can try running make setup again, or simply pdm install.
You now have the dependencies installed.
Run make help to see all the available actions!
Tasks¤
This project uses duty to run tasks. A Makefile is also provided. The Makefile will try to run certain tasks on multiple Python versions. If for some reason you don't want to run the task on multiple Python versions, you run the task directly with pdm run duty TASK.
The Makefile detects if a virtual environment is activated, so make will work the same with the virtualenv activated or not.
If you work in VSCode, see examples of tasks and run configurations.
Development¤
As usual:
- create a new branch:
git switch -c feature-or-bugfix-name - edit the code and/or the documentation
Before committing:
- run
make format to auto-format the code - run
make check to check everything (fix any warning) - run
make test to run the tests (fix any issue) - if you updated the documentation or the project dependencies:
- run
make docs - go to http://localhost:8000 and check that everything looks good
- follow our commit message convention
If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
Don't bother updating the changelog, we will take care of this.
Commit message convention¤
Commit messages must follow our convention based on the Angular style or the Karma convention:
<type>[(scope)]: Subject
+
Note
If it fails for some reason, you'll need to install uv manually.
You can install it with:
python3 -m pip install --user pipx
+pipx install uv
+
Now you can try running make setup again, or simply uv install.
You now have the dependencies installed.
Run make help to see all the available actions!
Tasks¤
This project uses duty to run tasks. A Makefile is also provided. The Makefile will try to run certain tasks on multiple Python versions. If for some reason you don't want to run the task on multiple Python versions, you run the task directly with make run duty TASK.
The Makefile detects if a virtual environment is activated, so make will work the same with the virtualenv activated or not.
If you work in VSCode, we provide an action to configure VSCode for the project.
Development¤
As usual:
- create a new branch:
git switch -c feature-or-bugfix-name - edit the code and/or the documentation
Before committing:
- run
make format to auto-format the code - run
make check to check everything (fix any warning) - run
make test to run the tests (fix any issue) - if you updated the documentation or the project dependencies:
- run
make docs - go to http://localhost:8000 and check that everything looks good
- follow our commit message convention
If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
Don't bother updating the changelog, we will take care of this.
Commit message convention¤
Commit messages must follow our convention based on the Angular style or the Karma convention:
<type>[(scope)]: Subject
[Body]
Subject and body must be valid Markdown. Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general.
Scope and body are optional. Type can be:
build: About packaging, building wheels, etc.chore: About packaging or repo/files management.ci: About Continuous Integration.deps: Dependencies update.docs: About documentation.feat: New feature.fix: Bug fix.perf: About performance.refactor: Changes that are not features or bug fixes.style: A change in code style/format.tests: About tests.
If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown:
Body.
@@ -13,4 +13,4 @@
git commit --fixup=SHA
Once all the changes are approved, you can squash your commits:
git rebase -i --autosquash main
And force-push:
git push -f
-
If this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging.
\ No newline at end of file
+If this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging.
Credits¤
These projects were used to build markdown-pycon. Thank you!
python | pdm | copier-pdm
Runtime dependencies¤
| Project | Summary | Version (accepted) | Version (last resolved) | License |
|---|---|---|---|---|
Development dependencies¤
| Project | Summary | Version (accepted) | Version (last resolved) | License |
|---|---|---|---|---|
ansimarkup | Produce colored terminal text with an xml-like markup | ~=1.4 | 1.5.0 | Revised BSD License |
babel | Internationalization utilities | >=2.10.3 | 2.12.1 | BSD |
beautifulsoup4 | Screen-scraping library | 4.12.2 | MIT License | |
black | The uncompromising code formatter. | >=23.1 | 23.7.0 | MIT |
blacken-docs | Run Black on Python code blocks in documentation files. | >=1.13 | 1.16.0 | MIT |
certifi | Python package for providing Mozilla's CA Bundle. | >=2017.4.17 | 2023.7.22 | MPL-2.0 |
charset-normalizer | The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet. | <4,>=2 | 3.2.0 | MIT |
click | Composable command line interface toolkit | >=8.0.0 | 8.1.7 | BSD-3-Clause |
colorama | Cross-platform colored terminal text. | ; platform_system == "Windows" | 0.4.6 | BSD License |
coverage | Code coverage measurement for Python | [toml]>=5.2.1 | 7.3.0 | Apache-2.0 |
csscompressor | A python port of YUI CSS Compressor | >=0.9.5 | 0.9.5 | BSD |
cssselect | cssselect parses CSS3 Selectors and translates them to XPath 1.0 | >=1.2.0 | 1.2.0 | BSD |
dparse | A parser for Python dependency files | >=0.6.2 | 0.6.3 | MIT license |
duty | A simple task runner. | >=0.10 | 1.0.0 | ISC |
exceptiongroup | Backport of PEP 654 (exception groups) | >=1.0.0rc8; python_version < "3.11" | 1.1.3 | ? |
execnet | execnet: rapid multi-Python deployment | >=1.1 | 2.0.2 | MIT License |
failprint | Run a command, print its output only if it fails. | >=0.11 | 1.0.1 | ISC |
ghp-import | Copy your docs directly to the gh-pages branch. | >=1.0 | 2.1.0 | Apache Software License |
git-changelog | Automatic Changelog generator using Jinja2 templates. | >=1.0 | 2.2.0 | ISC |
gitdb | Git Object Database | <5,>=4.0.1 | 4.0.10 | BSD License |
gitpython | GitPython is a Python library used to interact with Git repositories | 3.1.33 | BSD | |
griffe | Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API. | >=0.35 | 0.36.0 | ISC |
htmlmin2 | An HTML Minifier | >=0.1.13 | 0.1.13 | BSD |
idna | Internationalized Domain Names in Applications (IDNA) | <4,>=2.5 | 3.4 | BSD License |
importlib-metadata | Read metadata from Python packages | >=4.3; python_version < "3.10" | 6.8.0 | ? |
iniconfig | brain-dead simple config-ini parsing | 2.0.0 | MIT License | |
jinja2 | A very fast and expressive template engine. | <4,>=2.11 | 3.1.2 | BSD-3-Clause |
jsmin | JavaScript minifier. | >=3.0.1 | 3.0.1 | MIT License |
lxml | Powerful and Pythonic XML processing library combining libxml2/libxslt with the ElementTree API. | >=4.6 | 4.9.3 | BSD-3-Clause |
markdown | Python implementation of John Gruber's Markdown. | <4.0.0,>=3.3.3 | 3.4.4 | BSD License |
markdown-callouts | Markdown extension: a classier syntax for admonitions | >=0.2 | 0.3.0 | MIT |
markdown-exec | Utilities to execute code blocks in Markdown files. | >=0.5 | 1.6.0.1.0.1 | ISC |
markdown2 | A fast and complete Python implementation of Markdown | >=2.4.3 | 2.4.10 | MIT |
markupsafe | Safely add untrusted strings to HTML/XML markup. | >=2.0 | 2.1.3 | BSD-3-Clause |
mergedeep | A deep merge function for 🐍. | >=1.3.4 | 1.3.4 | MIT License |
mkdocs | Project documentation with Markdown. | >=1.5 | 1.5.2 | BSD License |
mkdocs-coverage | MkDocs plugin to integrate your coverage HTML report into your site. | >=0.2 | 1.0.0 | ISC |
mkdocs-gen-files | MkDocs plugin to programmatically generate documentation pages during the build | >=0.3 | 0.5.0 | MIT License |
mkdocs-git-committers-plugin-2 | An MkDocs plugin to create a list of contributors on the page | >=1.1 | 1.1.2 | MIT |
mkdocs-literate-nav | MkDocs plugin to specify the navigation in Markdown instead of YAML | >=0.4 | 0.6.0 | MIT License |
mkdocs-material | Documentation that simply works | >=7.3 | 9.2.6+insiders.4.40.2 | MIT License |
mkdocs-material-extensions | Extension pack for Python Markdown and MkDocs Material. | >=1.1 | 1.1.1 | MIT License |
mkdocs-minify-plugin | An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk | >=0.6.4 | 0.7.1 | MIT |
mkdocstrings | Automatic documentation from sources, for MkDocs. | [python]>=0.18 | 0.22.0 | ISC |
mkdocstrings-python | A Python handler for mkdocstrings. | >=0.5.2 | 1.6.0.1.4.0 | ISC |
mypy | Optional static typing for Python | >=0.910 | 1.5.1 | MIT License |
mypy-extensions | Type system extensions for programs checked with the mypy type checker. | >=0.4.3 | 1.0.0 | MIT License |
packaging | Core utilities for Python packages | >=22.0 | 23.1 | BSD License |
paginate | Divides large result sets into pages for easier browsing | >=0.5.6 | 0.5.6 | MIT |
pathspec | Utility library for gitignore style pattern matching of file paths. | >=0.9.0 | 0.11.2 | Mozilla Public License 2.0 (MPL 2.0) |
platformdirs | A small Python package for determining appropriate platform-specific dirs, e.g. a "user data dir". | >=2 | 3.10.0 | MIT License |
pluggy | plugin and hook calling mechanisms for python | <2.0,>=0.12 | 1.3.0 | MIT |
ptyprocess | Run a subprocess in a pseudo terminal | ~=0.6; sys_platform != "win32" | 0.7.0 | ISC License (ISCL) |
pygments | Pygments is a syntax highlighting package written in Python. | >=2.14 | 2.16.1 | BSD-2-Clause |
pymdown-extensions | Extension pack for Python Markdown. | >=9 | 10.2.1 | MIT License |
pyquery | A jquery-like library for python | >=1.2 | 2.0.0 | BSD |
pytest | pytest: simple powerful testing with Python | >=6.2 | 7.4.0 | MIT |
pytest-cov | Pytest plugin for measuring coverage. | >=3.0 | 4.1.0 | MIT |
pytest-randomly | Pytest plugin to randomly order tests and control random.seed. | >=3.10 | 3.15.0 | MIT |
pytest-xdist | pytest xdist plugin for distributed testing, most importantly across multiple CPUs | >=2.4 | 3.3.1 | MIT |
python-dateutil | Extensions to the standard Python datetime module | >=2.8.1 | 2.8.2 | Dual License |
pytz | World timezone definitions, modern and historical | >=2015.7; python_version < "3.9" | 2023.3 | ? |
pyyaml | YAML parser and emitter for Python | >=5.1 | 6.0.1 | MIT |
pyyaml-env-tag | A custom YAML tag for referencing environment variables in YAML files. | >=0.1 | 0.1 | MIT License |
readtime | Calculates the time some text takes the average human to read, based on Medium's read time forumula | >=2.0 | 3.0.0 | BSD |
regex | Alternative regular expression module, to replace re. | >=2022.4.24 | 2023.8.8 | Apache Software License |
requests | Python HTTP for Humans. | 2.31.0 | Apache 2.0 | |
ruamel-yaml | ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order | >=0.17.21 | 0.17.32 | MIT license |
ruamel-yaml-clib | C version of reader, parser and emitter for ruamel.yaml derived from libyaml | >=0.2.7; platform_python_implementation == "CPython" and python_version < "3.12" | 0.2.7 | MIT |
ruff | An extremely fast Python linter, written in Rust. | >=0.0.246 | 0.0.287 | MIT |
safety | Checks installed dependencies for known vulnerabilities and licenses. | >=2 | 2.3.4 | MIT license |
semver | Python helper for Semantic Versioning (https://semver.org) | >=2.13 | 3.0.1 | BSD |
setuptools | Easily download, build, install, upgrade, and uninstall Python packages | >=19.3 | 68.1.2 | MIT License |
six | Python 2 and 3 compatibility utilities | >=1.5 | 1.16.0 | MIT |
smmap | A pure Python implementation of a sliding window memory map manager | <6,>=3.0.1 | 5.0.0 | BSD |
soupsieve | A modern CSS selector implementation for Beautiful Soup. | >1.2 | 2.4.1 | MIT License |
toml | Python Library for Tom's Obvious, Minimal Language | >=0.10 | 0.10.2 | MIT |
tomli | A lil' TOML parser | >=1.1.0; python_version < "3.11" | 2.0.1 | ? |
types-markdown | Typing stubs for Markdown | >=3.3 | 3.4.2.10 | Apache-2.0 license |
types-pyyaml | Typing stubs for PyYAML | >=6.0 | 6.0.12.11 | Apache-2.0 license |
types-toml | Typing stubs for toml | >=0.10 | 0.10.8.7 | Apache-2.0 license |
typing-extensions | Backported and Experimental Type Hints for Python 3.7+ | >=3.10.0.0; python_version < "3.10" | 4.7.1 | Python Software Foundation License |
urllib3 | HTTP library with thread-safe connection pooling, file post, and more. | <3,>=1.21.1 | 2.0.4 | MIT License |
watchdog | Filesystem events monitoring | >=2.0 | 3.0.0 | Apache License 2.0 |
zipp | Backport of pathlib-compatible object wrapper for zip files | >=0.5 | 3.16.2 | ? |
Credits¤
These projects were used to build markdown-pycon. Thank you!
Development dependencies¤
| Project | Summary | Version (accepted) | Version (last resolved) | License |
|---|---|---|---|---|
| Babel | Internationalization utilities | ~=2.10 | 2.14.0 | BSD-3-Clause |
| GitPython | GitPython is a Python library used to interact with Git repositories | 3.1.42 | BSD-3-Clause | |
| Jinja2 | A very fast and expressive template engine. | >=2.11.1 | 3.1.3 | BSD-3-Clause |
| Markdown | Python implementation of John Gruber's Markdown. | >=3.3 | 3.5.2 | BSD License |
| MarkupSafe | Safely add untrusted strings to HTML/XML markup. | >=1.1 | 2.1.5 | BSD-3-Clause |
| PyYAML | YAML parser and emitter for Python | >=5.1 | 6.0.1 | MIT |
| Pygments | Pygments is a syntax highlighting package written in Python. | >=2.13.0, <3.0.0 | 2.17.2 | BSD-2-Clause |
| SecretStorage | Python bindings to FreeDesktop.org Secret Service API | >=3.2 | 3.3.3 | BSD 3-Clause License |
| ansimarkup | Produce colored terminal text with an xml-like markup | ~=1.4 | 1.5.0 | Revised BSD License |
| appdirs | A small Python module for determining appropriate platform-specific dirs, e.g. a "user data dir". | >=1.4 | 1.4.4 | MIT |
| black | The uncompromising code formatter. | >=23.9 | 24.3.0 | MIT |
| blacken-docs | Run Black on Python code blocks in documentation files. | >=1.16 | 1.16.0 | MIT |
| build | A simple, correct Python build frontend | >=1.0 | 1.1.1 | MIT License |
| certifi | Python package for providing Mozilla's CA Bundle. | >=2017.4.17 | 2024.2.2 | MPL-2.0 |
| cffi | Foreign Function Interface for Python calling C code. | >=1.12 | 1.16.0 | MIT |
| charset-normalizer | The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet. | >=2, <4 | 3.3.2 | MIT |
| click | Composable command line interface toolkit | >=7.0 | 8.1.7 | BSD-3-Clause |
| colorama | Cross-platform colored terminal text. | 0.4.6 | BSD License | |
| coverage | Code coverage measurement for Python | >=5.2.1 | 7.4.4 | Apache-2.0 |
| cryptography | cryptography is a package which provides cryptographic recipes and primitives to Python developers. | >=2.0 | 42.0.5 | Apache-2.0 OR BSD-3-Clause |
| csscompressor | A python port of YUI CSS Compressor | >=0.9.5 | 0.9.5 | BSD |
| docutils | Docutils -- Python Documentation Utilities | >=0.13.1 | 0.20.1 | public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt) |
| dparse | A parser for Python dependency files | >=0.6.2 | 0.6.3 | MIT license |
| duty | A simple task runner. | >=0.10 | 1.2.0 | ISC |
| execnet | execnet: rapid multi-Python deployment | >=1.1 | 2.0.2 | MIT |
| failprint | Run a command, print its output only if it fails. | >=0.11, !=1.0.0 | 1.0.2 | ISC |
| ghp-import | Copy your docs directly to the gh-pages branch. | >=1.0 | 2.1.0 | Apache Software License |
| git-changelog | Automatic Changelog generator using Jinja2 templates. | >=2.3 | 2.4.1 | ISC |
| gitdb | Git Object Database | >=4.0.1, <5 | 4.0.11 | BSD License |
| griffe | Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API. | >=0.40 | 0.42.0.1.2.0 | ISC |
| htmlmin2 | An HTML Minifier | >=0.1.13 | 0.1.13 | BSD |
| idna | Internationalized Domain Names in Applications (IDNA) | >=2.5, <4 | 3.6 | BSD License |
| importlib_metadata | Read metadata from Python packages | >=4.6 | 7.0.2 | Apache Software License |
| iniconfig | brain-dead simple config-ini parsing | 2.0.0 | MIT | |
| jaraco.classes | Utility functions for Python class constructs | 3.3.1 | MIT License | |
| jeepney | Low-level, pure Python DBus protocol wrapper. | >=0.4.2 | 0.8.0 | MIT License |
| jsmin | JavaScript minifier. | >=3.0.1 | 3.0.1 | MIT License |
| keyring | Store and access your passwords safely. | >=15.1 | 24.3.1 | MIT License |
| markdown-callouts | Markdown extension: a classier syntax for admonitions | >=0.3 | 0.4.0 | MIT |
| markdown-exec | Utilities to execute code blocks in Markdown files. | >=1.7 | 1.7.0.1.0.1 | ISC |
| markdown-it-py | Python port of markdown-it. Markdown parsing, done right! | >=2.2.0 | 3.0.0 | MIT License |
| mdurl | Markdown URL utilities | ~=0.1 | 0.1.2 | MIT License |
| mergedeep | A deep merge function for 🐍. | >=1.3.4 | 1.3.4 | MIT License |
| mkdocs | Project documentation with Markdown. | >=1.5 | 1.5.3 | BSD-2-Clause |
| mkdocs-autorefs | Automatically link across pages in MkDocs. | >=0.3.1 | 1.0.1 | ISC |
| mkdocs-coverage | MkDocs plugin to integrate your coverage HTML report into your site. | >=1.0 | 1.0.0 | ISC |
| mkdocs-gen-files | MkDocs plugin to programmatically generate documentation pages during the build | >=0.5 | 0.5.0 | MIT |
| mkdocs-git-committers-plugin-2 | An MkDocs plugin to create a list of contributors on the page. The git-committers plugin will seed the template context with a list of GitHub or GitLab committers and other useful GIT info such as last modified date | >=1.2 | 2.3.0 | MIT |
| mkdocs-literate-nav | MkDocs plugin to specify the navigation in Markdown instead of YAML | >=0.6 | 0.6.1 | MIT |
| mkdocs-material | Documentation that simply works | >=9.4 | 9.5.14+insiders.4.53.2 | MIT |
| mkdocs-material-extensions | Extension pack for Python Markdown and MkDocs Material. | ~=1.3 | 1.3.1 | MIT |
| mkdocs-minify-plugin | An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk | >=0.7 | 0.8.0 | MIT |
| mkdocstrings | Automatic documentation from sources, for MkDocs. | >=0.23 | 0.24.1 | ISC |
| mkdocstrings-python | A Python handler for mkdocstrings. | >=0.5.2 | 1.9.0.1.6.0 | ISC |
| more-itertools | More routines for operating on iterables, beyond itertools | 10.2.0 | MIT License | |
| mypy | Optional static typing for Python | >=1.5 | 1.9.0 | MIT |
| mypy-extensions | Type system extensions for programs checked with the mypy type checker. | >=1.0.0 | 1.0.0 | MIT License |
| nh3 | Python bindings to the ammonia HTML sanitization library. | >=0.2.14 | 0.2.15 | MIT |
| packaging | Core utilities for Python packages | 24.0 | Apache Software License + BSD License | |
| paginate | Divides large result sets into pages for easier browsing | ~=0.5 | 0.5.6 | MIT |
| pathspec | Utility library for gitignore style pattern matching of file paths. | >=0.11.1 | 0.12.1 | Mozilla Public License 2.0 (MPL 2.0) |
| pkginfo | Query metadata from sdists / bdists / installed packages. | >=1.8.1 | 1.10.0 | MIT |
| platformdirs | A small Python package for determining appropriate platform-specific dirs, e.g. a "user data dir". | >=2.2.0 | 4.2.0 | MIT |
| pluggy | plugin and hook calling mechanisms for python | >=1.4, <2.0 | 1.4.0 | MIT |
| ptyprocess | Run a subprocess in a pseudo terminal | ~=0.6 | 0.7.0 | ISC License (ISCL) |
| pycparser | C parser in Python | 2.21 | BSD | |
| pymdown-extensions | Extension pack for Python Markdown. | >=6.3 | 10.7.1 | MIT |
| pyproject_hooks | Wrappers to call pyproject.toml-based build backend hooks. | 1.0.0 | MIT License | |
| pytest | pytest: simple powerful testing with Python | >=7.4 | 8.1.1 | MIT |
| pytest-cov | Pytest plugin for measuring coverage. | >=4.1 | 4.1.0 | MIT |
| pytest-randomly | Pytest plugin to randomly order tests and control random.seed. | >=3.15 | 3.15.0 | MIT |
| pytest-xdist | pytest xdist plugin for distributed testing, most importantly across multiple CPUs | >=3.3 | 3.5.0 | MIT |
| python-dateutil | Extensions to the standard Python datetime module | >=2.8.1 | 2.9.0.post0 | BSD License + Apache Software License |
| pyyaml_env_tag | A custom YAML tag for referencing environment variables in YAML files. | >=0.1 | 0.1 | MIT License |
| readme_renderer | readme_renderer is a library for rendering readme descriptions for Warehouse | >=35.0 | 43.0 | Apache License, Version 2.0 |
| regex | Alternative regular expression module, to replace re. | >=2022.4 | 2023.12.25 | Apache Software License |
| requests | Python HTTP for Humans. | 2.31.0 | Apache 2.0 | |
| requests-toolbelt | A utility belt for advanced users of python-requests | >=0.8.0, !=0.9.0 | 1.0.0 | Apache 2.0 |
| rfc3986 | Validating URI References per RFC 3986 | >=1.4.0 | 2.0.0 | Apache 2.0 |
| rich | Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal | >=12.0.0 | 13.7.1 | MIT |
| ruamel.yaml | ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order | >=0.17.21 | 0.18.6 | MIT license |
| ruamel.yaml.clib | C version of reader, parser and emitter for ruamel.yaml derived from libyaml | >=0.2.7 | 0.2.8 | MIT |
| ruff | An extremely fast Python linter and code formatter, written in Rust. | >=0.0 | 0.3.3 | MIT |
| safety | Checks installed dependencies for known vulnerabilities and licenses. | >=2.3 | 2.3.4 | MIT license |
| semver | Python helper for Semantic Versioning (https://semver.org) | >=2.13 | 3.0.2 | BSD |
| setuptools | Easily download, build, install, upgrade, and uninstall Python packages | >=19.3 | 69.2.0 | MIT License |
| six | Python 2 and 3 compatibility utilities | >=1.5 | 1.16.0 | MIT |
| smmap | A pure Python implementation of a sliding window memory map manager | >=3.0.1, <6 | 5.0.1 | BSD |
| twine | Collection of utilities for publishing packages on PyPI | >=5.0 | 5.0.0 | Apache Software License |
| types-Markdown | Typing stubs for Markdown | >=3.5 | 3.6.0.20240316 | Apache-2.0 license |
| types-PyYAML | Typing stubs for PyYAML | >=6.0 | 6.0.12.20240311 | Apache-2.0 license |
| typing_extensions | Backported and Experimental Type Hints for Python 3.8+ | >=4.1 | 4.10.0 | Python Software Foundation License |
| urllib3 | HTTP library with thread-safe connection pooling, file post, and more. | >=1.26.0 | 2.2.1 | MIT License |
| watchdog | Filesystem events monitoring | >=2.0 | 4.0.0 | Apache-2.0 |
| zipp | Backport of pathlib-compatible object wrapper for zip files | >=0.5 | 3.18.1 | MIT License |
Markdown PyCon¤
Markdown extension to parse pycon code blocks without indentation or fences.
Installation¤
With pip:
pip install markdown-pycon
-Configuration¤
This extension relies on the Highlight extension of PyMdown Extensions.
Configure from Python:
from markdown import Markdown
+ Overview - Markdown PyCon Markdown PyCon¤
Markdown extension to parse pycon code blocks without indentation or fences.
Installation¤
This project is available to sponsors only, through my Insiders program. See Insiders explanation and installation instructions.
Configuration¤
This extension relies on the Highlight extension of PyMdown Extensions.
Configure from Python:
from markdown import Markdown
Markdown(extensions=["pycon"])
...or in MkDocs configuration file, as a Markdown extension:
# mkdocs.yml
@@ -9,4 +8,4 @@
This is a pycon code block
This will get rendered as:
>>> print("This is a pycon code block")
This is a pycon code block
-
Doctest flags will be removed from the code lines.
\ No newline at end of file
+Doctest flags will be removed from the code lines.
Insiders¤
Markdown PyCon follows the sponsorware release strategy, which means that new features are first exclusively released to sponsors as part of Insiders. Read on to learn what sponsorships achieve, how to become a sponsor to get access to Insiders, and what's in it for you!
What is Insiders?¤
Markdown PyCon Insiders is a private fork of Markdown PyCon, hosted as a private GitHub repository. Almost1 all new features are developed as part of this fork, which means that they are immediately available to all eligible sponsors, as they are made collaborators of this repository.
Every feature is tied to a funding goal in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into Markdown PyCon and released for general availability, making them available to all users. Bugfixes are always released in tandem.
Sponsorships start as low as $10 a month.2
What sponsorships achieve¤
Sponsorships make this project sustainable, as they buy the maintainers of this project time – a very scarce resource – which is spent on the development of new features, bug fixing, stability improvement, issue triage and general support. The biggest bottleneck in Open Source is time.3
If you're unsure if you should sponsor this project, check out the list of completed funding goals to learn whether you're already using features that were developed with the help of sponsorships. You're most likely using at least a handful of them, thanks to our awesome sponsors!
What's in it for me?¤
The moment you become a sponsor, you'll get immediate access to 1 additional features that you can start using right away, and which are currently exclusively available to sponsors:
How to become a sponsor¤
Thanks for your interest in sponsoring! In order to become an eligible sponsor with your GitHub account, visit pawamoy's sponsor profile, and complete a sponsorship of $10 a month or more. You can use your individual or organization GitHub account for sponsoring.
Important: If you're sponsoring @pawamoy through a GitHub organization, please send a short email to pawamoy@pm.me with the name of your organization and the GitHub account of the individual that should be added as a collaborator.4
You can cancel your sponsorship anytime.5
If you sponsor publicly, you're automatically added here with a link to your profile and avatar to show your support for Markdown PyCon. Alternatively, if you wish to keep your sponsorship private, you'll be a silent +1. You can select visibility during checkout and change it afterwards.
Funding ¤
Goals¤
The following section lists all funding goals. Each goal contains a list of features prefixed with a checkmark symbol, denoting whether a feature is already available or planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
$ 1,000 — GraviFridge User Manual¤
Goals completed¤
This section lists all funding goals that were previously completed, which means that those features were part of Insiders, but are now generally available and can be used by all users.
Frequently asked questions¤
Compatibility¤
We're building an open source project and want to allow outside collaborators to use Markdown PyCon locally without having access to Insiders. Is this still possible?
Yes. Insiders is compatible with Markdown PyCon. Almost all new features and configuration options are either backward-compatible or implemented behind feature flags. Most Insiders features enhance the overall experience, though while these features add value for the users of your project, they shouldn't be necessary for previewing when making changes to content.
Payment¤
We don't want to pay for sponsorship every month. Are there any other options?
Yes. You can sponsor on a yearly basis by switching your GitHub account to a yearly billing cycle. If for some reason you cannot do that, you could also create a dedicated GitHub account with a yearly billing cycle, which you only use for sponsoring (some sponsors already do that).
If you have any problems or further questions, please reach out to pawamoy@pm.me.
Terms¤
Are we allowed to use Insiders under the same terms and conditions as Markdown PyCon?
Yes. Whether you're an individual or a company, you may use Markdown PyCon Insiders precisely under the same terms as Markdown PyCon, which are given by the ISC License. However, we kindly ask you to respect our fair use policy:
-
Please don't distribute the source code of Insiders. You may freely use it for public, private or commercial projects, privately fork or mirror it, but please don't make the source code public, as it would counteract the sponsorware strategy.
-
If you cancel your subscription, you're automatically removed as a collaborator and will miss out on all future updates of Insiders. However, you may use the latest version that's available to you as long as you like. Just remember that GitHub deletes private forks.
-
In general, every new feature is first exclusively released to sponsors, but sometimes upstream dependencies enhance existing features that must be supported by Markdown PyCon. ↩
-
Note that $10 a month is the minimum amount to become eligible for Insiders. While GitHub Sponsors also allows to sponsor lower amounts or one-time amounts, those can't be granted access to Insiders due to technical reasons. Such contributions are still very much welcome as they help ensuring the project's sustainability. ↩
-
Making an Open Source project sustainable is exceptionally hard: maintainers burn out, projects are abandoned. That's not great and very unpredictable. The sponsorware model ensures that if you decide to use Markdown PyCon, you can be sure that bugs are fixed quickly and new features are added regularly. ↩
-
It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to pawamoy@pm.me, stating which account should become a collaborator of the Insiders repository. We're working on a solution which will make access to organizations much simpler. To ensure that access is not tied to a particular individual GitHub account, create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being added to the list of collaborators, the bot account can create a private fork of the private Insiders GitHub repository, and grant access to all members of the organizations. ↩
-
If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable. ↩
Insiders¤
Markdown PyCon follows the sponsorware release strategy, which means that new features are first exclusively released to sponsors as part of Insiders. Read on to learn what sponsorships achieve, how to become a sponsor to get access to Insiders, and what's in it for you!
What is Insiders?¤
Markdown PyCon Insiders is a private fork of Markdown PyCon, hosted as a private GitHub repository. Almost1 all new features are developed as part of this fork, which means that they are immediately available to all eligible sponsors, as they are made collaborators of this repository.
Every feature is tied to a funding goal in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into Markdown PyCon and released for general availability, making them available to all users. Bugfixes are always released in tandem.
Sponsorships start as low as $10 a month.2
What sponsorships achieve¤
Sponsorships make this project sustainable, as they buy the maintainers of this project time – a very scarce resource – which is spent on the development of new features, bug fixing, stability improvement, issue triage and general support. The biggest bottleneck in Open Source is time.3
If you're unsure if you should sponsor this project, check out the list of completed funding goals to learn whether you're already using features that were developed with the help of sponsorships. You're most likely using at least a handful of them, thanks to our awesome sponsors!
What's in it for me?¤
The moment you become a sponsor, you'll get immediate access to 1 additional features that you can start using right away, and which are currently exclusively available to sponsors:
These are just the features related to this project. See the complete feature list on the author's main Insiders page.
How to become a sponsor¤
Thanks for your interest in sponsoring! In order to become an eligible sponsor with your GitHub account, visit pawamoy's sponsor profile, and complete a sponsorship of $10 a month or more. You can use your individual or organization GitHub account for sponsoring.
Important: If you're sponsoring @pawamoy through a GitHub organization, please send a short email to insiders@pawamoy.fr with the name of your organization and the GitHub account of the individual that should be added as a collaborator.4
You can cancel your sponsorship anytime.5
If you sponsor publicly, you're automatically added here with a link to your profile and avatar to show your support for Markdown PyCon. Alternatively, if you wish to keep your sponsorship private, you'll be a silent +1. You can select visibility during checkout and change it afterwards.
Funding ¤
Goals¤
The following section lists all funding goals. Each goal contains a list of features prefixed with a checkmark symbol, denoting whether a feature is already available or planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
$ 1,000 — GraviFridge Fluid Renewal¤
$ 1,500 — HyperLamp Navigation Tips¤
There are no features in this goal for this project.
See the features in this goal for all Insiders projects.
$ 2,000 — FusionDrive Ejection Configuration¤
There are no features in this goal for this project.
See the features in this goal for all Insiders projects.
Goals completed¤
This section lists all funding goals that were previously completed, which means that those features were part of Insiders, but are now generally available and can be used by all users.
$ 500 — PlasmaVac User Guide¤
There are no features in this goal for this project.
See the features in this goal for all Insiders projects.
Frequently asked questions¤
Compatibility¤
We're building an open source project and want to allow outside collaborators to use Markdown PyCon locally without having access to Insiders. Is this still possible?
Yes. Insiders is compatible with Markdown PyCon. Almost all new features and configuration options are either backward-compatible or implemented behind feature flags. Most Insiders features enhance the overall experience, though while these features add value for the users of your project, they shouldn't be necessary for previewing when making changes to content.
Payment¤
We don't want to pay for sponsorship every month. Are there any other options?
Yes. You can sponsor on a yearly basis by switching your GitHub account to a yearly billing cycle. If for some reason you cannot do that, you could also create a dedicated GitHub account with a yearly billing cycle, which you only use for sponsoring (some sponsors already do that).
If you have any problems or further questions, please reach out to insiders@pawamoy.fr.
Terms¤
Are we allowed to use Insiders under the same terms and conditions as Markdown PyCon?
Yes. Whether you're an individual or a company, you may use Markdown PyCon Insiders precisely under the same terms as Markdown PyCon, which are given by the ISC License. However, we kindly ask you to respect our fair use policy:
-
Please don't distribute the source code of Insiders. You may freely use it for public, private or commercial projects, privately fork or mirror it, but please don't make the source code public, as it would counteract the sponsorware strategy.
-
If you cancel your subscription, you're automatically removed as a collaborator and will miss out on all future updates of Insiders. However, you may use the latest version that's available to you as long as you like. Just remember that GitHub deletes private forks.
-
In general, every new feature is first exclusively released to sponsors, but sometimes upstream dependencies enhance existing features that must be supported by Markdown PyCon. ↩
-
Note that $10 a month is the minimum amount to become eligible for Insiders. While GitHub Sponsors also allows to sponsor lower amounts or one-time amounts, those can't be granted access to Insiders due to technical reasons. Such contributions are still very much welcome as they help ensuring the project's sustainability. ↩
-
Making an Open Source project sustainable is exceptionally hard: maintainers burn out, projects are abandoned. That's not great and very unpredictable. The sponsorware model ensures that if you decide to use Markdown PyCon, you can be sure that bugs are fixed quickly and new features are added regularly. ↩
-
It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to insiders@pawamoy.fr, stating which account should become a collaborator of the Insiders repository. We're working on a solution which will make access to organizations much simpler. To ensure that access is not tied to a particular individual GitHub account, create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being added to the list of collaborators, the bot account can create a private fork of the private Insiders GitHub repository, and grant access to all members of the organizations. ↩
-
If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable. ↩
Getting started with Insiders¤
Markdown PyCon Insiders is a compatible drop-in replacement for Markdown PyCon, and can be installed similarly using pip or git. Note that in order to access the Insiders repository, you need to become an eligible sponsor of @pawamoy on GitHub.
Installation¤
with PyPI Insiders¤
PyPI Insiders is a tool that helps you keep up-to-date versions of Insiders projects in the PyPI index of your choice (self-hosted, Google registry, Artifactory, etc.).
See how to install it and how to use it.
with pip (ssh/https)¤
Markdown PyCon Insiders can be installed with pip using SSH:
pip install git+ssh://git@github.com/pawamoy-insiders/markdown-pycon.git
+ Getting started with Insiders - Markdown PyCon Getting started with Insiders¤
Markdown PyCon Insiders is a compatible drop-in replacement for Markdown PyCon, and can be installed similarly using pip or git. Note that in order to access the Insiders repository, you need to become an eligible sponsor of @pawamoy on GitHub.
Installation¤
with PyPI Insiders¤
PyPI Insiders is a tool that helps you keep up-to-date versions of Insiders projects in the PyPI index of your choice (self-hosted, Google registry, Artifactory, etc.).
See how to install it and how to use it.
with pip (ssh/https)¤
Markdown PyCon Insiders can be installed with pip using SSH:
pip install git+ssh://git@github.com/pawamoy-insiders/markdown-pycon.git
Or using HTTPS:
pip install git+https://${GH_TOKEN}@github.com/pawamoy-insiders/markdown-pycon.git
How to get a GitHub personal access token
The GH_TOKEN environment variable is a GitHub token. It can be obtained by creating a personal access token for your GitHub account. It will give you access to the Insiders repository, programmatically, from the command line or GitHub Actions workflows:
- Go to https://github.com/settings/tokens
- Click on Generate a new token
- Enter a name and select the
repo scope - Generate the token and store it in a safe place
Note that the personal access token must be kept secret at all times, as it allows the owner to access your private repositories.
with pip (self-hosted)¤
Self-hosting the Insiders package makes it possible to depend on Markdown PyCon normally, while transparently downloading and installing the Insiders version locally. It means that you can specify your dependencies normally, and your contributors without access to Insiders will get the public version, while you get the Insiders version on your machine.
Limitation
With this method, there is no way to force the installation of an Insiders version rather than a public version. If there is a public version that is more recent than your self-hosted Insiders version, the public version will take precedence. Remember to regularly update your self-hosted versions by uploading latest distributions.
You can build the distributions for Insiders yourself, by cloning the repository and using build to build the distributions, or you can download them from our GitHub Releases. You can upload these distributions to a private PyPI-like registry (Artifactory, Google Cloud, pypiserver, etc.) with Twine:
# download distributions in ~/dists, then upload with:
twine upload --repository-url https://your-private-index.com ~/dists/*
@@ -39,4 +39,4 @@
pdm config pypi.extra.url http://localhost:8080/simple
Now when running pip install markdown-pycon, or resolving dependencies with PDM, both tools will look into our local index and find the Insiders version. Remember to update your local index regularly!
with git¤
Of course, you can use Markdown PyCon Insiders directly from git:
git clone git@github.com:pawamoy-insiders/markdown-pycon
When cloning from git, the package must be installed:
pip install -e markdown-pycon
-
Upgrading¤
When upgrading Insiders, you should always check the version of Markdown PyCon which makes up the first part of the version qualifier. For example, a version like 8.x.x.4.x.x means that Insiders 4.x.x is currently based on 8.x.x.
If the major version increased, it's a good idea to consult the changelog and go through the steps to ensure your configuration is up to date and all necessary changes have been made.
\ No newline at end of file
+Upgrading¤
When upgrading Insiders, you should always check the version of Markdown PyCon which makes up the first part of the version qualifier. For example, a version like 8.x.x.4.x.x means that Insiders 4.x.x is currently based on 8.x.x.
If the major version increased, it's a good idea to consult the changelog and go through the steps to ensure your configuration is up to date and all necessary changes have been made.
`
+ sponsors.forEach(function (sponsor) {
+ html += `
+
+
+
+ `
+ });
+ html += '
'
- sponsors.forEach(function (sponsor) {
- html += `
-
-
-
- `
- });
- html += '
License¤
ISC License
+ License - Markdown PyCon License¤
ISC License
Copyright (c) 2023, Timothée Mazzucotelli
@@ -13,4 +13,4 @@
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
\ No newline at end of file
+SUMMARY
Debugging utilities.
Classes:
-
Environment–Dataclass to store environment information.
-
Package–Dataclass describing a Python package.
-
Variable–Dataclass describing an environment variable.
Functions:
-
get_debug_info–Get debug/environment information.
-
get_version–Get version of the given distribution.
-
print_debug_info–Print debug/environment information.
dataclass ¤
Environment(
+ interpreter_name: str,
+ interpreter_version: str,
+ interpreter_path: str,
+ platform: str,
+ packages: list[Package],
+ variables: list[Variable],
+)
+Dataclass to store environment information.
Attributes:
-
interpreter_name(str) –Python interpreter name.
-
interpreter_path(str) –Path to Python executable.
-
interpreter_version(str) –Python interpreter version.
-
packages(list[Package]) –Installed packages.
-
platform(str) –Operating System.
-
variables(list[Variable]) –Environment variables.
dataclass ¤
dataclass ¤
get_debug_info() -> Environment
+
Markdown PyCon package.
Markdown extension to parse pycon code blocks without indentation or fences.
Bases: BlockProcessor
Our block processor.
Bases: Extension
Our Markdown extension.
extendMarkdown(md: Markdown) -> None
-Register the block processor.
Add an instance of our PyConBlockProcessor to the Markdown parser.
Parameters:
- md (
Markdown) –A Markdown instance.
Markdown PyCon package.
Markdown extension to parse pycon code blocks without indentation or fences.
Modules:
-
debug–Debugging utilities.
Classes:
-
PyConBlockProcessor–Our block processor.
-
PyConExtension–Our Markdown extension.
Functions:
-
makeExtension–Return extension.
Bases: BlockProcessor
Our block processor.
Bases: Extension
Our Markdown extension.
Methods:
-
extendMarkdown–Register the block processor.
extendMarkdown(md: Markdown) -> None
+Register the block processor.
Add an instance of our PyConBlockProcessor to the Markdown parser.
Parameters:
-
md(Markdown) –A Markdown instance.
Markdown extension to parse pycon code blocks without indentation or fences.
With pip:
pip install markdown-pycon\nThis extension relies on the Highlight extension of PyMdown Extensions.
Configure from Python:
from markdown import Markdown\n\nMarkdown(extensions=[\"pycon\"])\n...or in MkDocs configuration file, as a Markdown extension:
# mkdocs.yml\nmarkdown_extensions:\n- pycon\nIn your Markdown documents, simply write your pycon code blocks without indentation or fences (triple backticks):
>>> print(\"This is a pycon code block\")\nThis is a pycon code block\nThis will get rendered as:
>>> print(\"This is a pycon code block\")\nThis is a pycon code block\nDoctest flags will be removed from the code lines.
"},{"location":"changelog/","title":"Changelog","text":"All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
"},{"location":"code_of_conduct/","title":"Contributor Covenant Code of Conduct","text":""},{"location":"code_of_conduct/#our-pledge","title":"Our Pledge","text":"We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
"},{"location":"code_of_conduct/#our-standards","title":"Our Standards","text":"Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
"},{"location":"code_of_conduct/#scope","title":"Scope","text":"This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
"},{"location":"code_of_conduct/#enforcement","title":"Enforcement","text":"Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at pawamoy@pm.me. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
"},{"location":"code_of_conduct/#enforcement-guidelines","title":"Enforcement Guidelines","text":"Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
"},{"location":"code_of_conduct/#1-correction","title":"1. Correction","text":"Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
"},{"location":"code_of_conduct/#2-warning","title":"2. Warning","text":"Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
"},{"location":"code_of_conduct/#3-temporary-ban","title":"3. Temporary Ban","text":"Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
"},{"location":"code_of_conduct/#4-permanent-ban","title":"4. Permanent Ban","text":"Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
"},{"location":"code_of_conduct/#attribution","title":"Attribution","text":"This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
"},{"location":"contributing/","title":"Contributing","text":"Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
"},{"location":"contributing/#environment-setup","title":"Environment setup","text":"Nothing easier!
Fork and clone the repository, then:
cd markdown-pycon\nmake setup\nNote
If it fails for some reason, you'll need to install PDM manually.
You can install it with:
python3 -m pip install --user pipx\npipx install pdm\nNow you can try running make setup again, or simply pdm install.
You now have the dependencies installed.
Run make help to see all the available actions!
This project uses duty to run tasks. A Makefile is also provided. The Makefile will try to run certain tasks on multiple Python versions. If for some reason you don't want to run the task on multiple Python versions, you run the task directly with pdm run duty TASK.
The Makefile detects if a virtual environment is activated, so make will work the same with the virtualenv activated or not.
If you work in VSCode, see examples of tasks and run configurations.
"},{"location":"contributing/#development","title":"Development","text":"As usual:
- create a new branch:
git switch -c feature-or-bugfix-name - edit the code and/or the documentation
Before committing:
- run
make formatto auto-format the code - run
make checkto check everything (fix any warning) - run
make testto run the tests (fix any issue) - if you updated the documentation or the project dependencies:
- run
make docs - go to http://localhost:8000 and check that everything looks good
- run
- follow our commit message convention
If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
Don't bother updating the changelog, we will take care of this.
"},{"location":"contributing/#commit-message-convention","title":"Commit message convention","text":"Commit messages must follow our convention based on the Angular style or the Karma convention:
<type>[(scope)]: Subject\n\n[Body]\nSubject and body must be valid Markdown. Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general.
Scope and body are optional. Type can be:
build: About packaging, building wheels, etc.chore: About packaging or repo/files management.ci: About Continuous Integration.deps: Dependencies update.docs: About documentation.feat: New feature.fix: Bug fix.perf: About performance.refactor: Changes that are not features or bug fixes.style: A change in code style/format.tests: About tests.
If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown:
Body.\n\nIssue #10: https://github.com/namespace/project/issues/10\nRelated to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15\nThese \"trailers\" must appear at the end of the body, without any blank lines between them. The trailer title can contain any character except colons :. We expect a full URI for each trailer, not just GitHub autolinks (for example, full GitHub URLs for commits and issues, not the hash or the #issue-number).
We do not enforce a line length on commit messages summary and body, but please avoid very long summaries, and very long lines in the body, unless they are part of code blocks that must not be wrapped.
"},{"location":"contributing/#pull-requests-guidelines","title":"Pull requests guidelines","text":"Link to any related issue in the Pull Request message.
During the review, we recommend using fixups:
# SHA is the SHA of the commit you want to fix\ngit commit --fixup=SHA\nOnce all the changes are approved, you can squash your commits:
git rebase -i --autosquash main\nAnd force-push:
git push -f\nIf this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging.
"},{"location":"credits/","title":"Credits","text":""},{"location":"credits/#exec-1--credits","title":"Credits","text":"These projects were used to build markdown-pycon. Thank you!
python | pdm | copier-pdm
ansimarkup Produce colored terminal text with an xml-like markup ~=1.4 1.5.0 Revised BSD License babel Internationalization utilities >=2.10.3 2.12.1 BSD beautifulsoup4 Screen-scraping library 4.12.2 MIT License black The uncompromising code formatter. >=23.1 23.7.0 MIT blacken-docs Run Black on Python code blocks in documentation files. >=1.13 1.16.0 MIT certifi Python package for providing Mozilla's CA Bundle. >=2017.4.17 2023.7.22 MPL-2.0 charset-normalizer The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet. <4,>=2 3.2.0 MIT click Composable command line interface toolkit >=8.0.0 8.1.7 BSD-3-Clause colorama Cross-platform colored terminal text. ; platform_system == \"Windows\" 0.4.6 BSD License coverage Code coverage measurement for Python [toml]>=5.2.1 7.3.0 Apache-2.0 csscompressor A python port of YUI CSS Compressor >=0.9.5 0.9.5 BSD cssselect cssselect parses CSS3 Selectors and translates them to XPath 1.0 >=1.2.0 1.2.0 BSD dparse A parser for Python dependency files >=0.6.2 0.6.3 MIT license duty A simple task runner. >=0.10 1.0.0 ISC exceptiongroup Backport of PEP 654 (exception groups) >=1.0.0rc8; python_version < \"3.11\" 1.1.3 ? execnet execnet: rapid multi-Python deployment >=1.1 2.0.2 MIT License failprint Run a command, print its output only if it fails. >=0.11 1.0.1 ISC ghp-import Copy your docs directly to the gh-pages branch. >=1.0 2.1.0 Apache Software License git-changelog Automatic Changelog generator using Jinja2 templates. >=1.0 2.2.0 ISC gitdb Git Object Database <5,>=4.0.1 4.0.10 BSD License gitpython GitPython is a Python library used to interact with Git repositories 3.1.33 BSD griffe Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API. >=0.35 0.36.0 ISC htmlmin2 An HTML Minifier >=0.1.13 0.1.13 BSD idna Internationalized Domain Names in Applications (IDNA) <4,>=2.5 3.4 BSD License importlib-metadata Read metadata from Python packages >=4.3; python_version < \"3.10\" 6.8.0 ? iniconfig brain-dead simple config-ini parsing 2.0.0 MIT License jinja2 A very fast and expressive template engine. <4,>=2.11 3.1.2 BSD-3-Clause jsmin JavaScript minifier. >=3.0.1 3.0.1 MIT License lxml Powerful and Pythonic XML processing library combining libxml2/libxslt with the ElementTree API. >=4.6 4.9.3 BSD-3-Clause markdown Python implementation of John Gruber's Markdown. <4.0.0,>=3.3.3 3.4.4 BSD License markdown-callouts Markdown extension: a classier syntax for admonitions >=0.2 0.3.0 MIT markdown-exec Utilities to execute code blocks in Markdown files. >=0.5 1.6.0.1.0.1 ISC markdown2 A fast and complete Python implementation of Markdown >=2.4.3 2.4.10 MIT markupsafe Safely add untrusted strings to HTML/XML markup. >=2.0 2.1.3 BSD-3-Clause mergedeep A deep merge function for \ud83d\udc0d. >=1.3.4 1.3.4 MIT License mkdocs Project documentation with Markdown. >=1.5 1.5.2 BSD License mkdocs-coverage MkDocs plugin to integrate your coverage HTML report into your site. >=0.2 1.0.0 ISC mkdocs-gen-files MkDocs plugin to programmatically generate documentation pages during the build >=0.3 0.5.0 MIT License mkdocs-git-committers-plugin-2 An MkDocs plugin to create a list of contributors on the page >=1.1 1.1.2 MIT mkdocs-literate-nav MkDocs plugin to specify the navigation in Markdown instead of YAML >=0.4 0.6.0 MIT License mkdocs-material Documentation that simply works >=7.3 9.2.6+insiders.4.40.2 MIT License mkdocs-material-extensions Extension pack for Python Markdown and MkDocs Material. >=1.1 1.1.1 MIT License mkdocs-minify-plugin An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk >=0.6.4 0.7.1 MIT mkdocstrings Automatic documentation from sources, for MkDocs. [python]>=0.18 0.22.0 ISC mkdocstrings-python A Python handler for mkdocstrings. >=0.5.2 1.6.0.1.4.0 ISC mypy Optional static typing for Python >=0.910 1.5.1 MIT License mypy-extensions Type system extensions for programs checked with the mypy type checker. >=0.4.3 1.0.0 MIT License packaging Core utilities for Python packages >=22.0 23.1 BSD License paginate Divides large result sets into pages for easier browsing >=0.5.6 0.5.6 MIT pathspec Utility library for gitignore style pattern matching of file paths. >=0.9.0 0.11.2 Mozilla Public License 2.0 (MPL 2.0) platformdirs A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\". >=2 3.10.0 MIT License pluggy plugin and hook calling mechanisms for python <2.0,>=0.12 1.3.0 MIT ptyprocess Run a subprocess in a pseudo terminal ~=0.6; sys_platform != \"win32\" 0.7.0 ISC License (ISCL) pygments Pygments is a syntax highlighting package written in Python. >=2.14 2.16.1 BSD-2-Clause pymdown-extensions Extension pack for Python Markdown. >=9 10.2.1 MIT License pyquery A jquery-like library for python >=1.2 2.0.0 BSD pytest pytest: simple powerful testing with Python >=6.2 7.4.0 MIT pytest-cov Pytest plugin for measuring coverage. >=3.0 4.1.0 MIT pytest-randomly Pytest plugin to randomly order tests and control random.seed. >=3.10 3.15.0 MIT pytest-xdist pytest xdist plugin for distributed testing, most importantly across multiple CPUs >=2.4 3.3.1 MIT python-dateutil Extensions to the standard Python datetime module >=2.8.1 2.8.2 Dual License pytz World timezone definitions, modern and historical >=2015.7; python_version < \"3.9\" 2023.3 ? pyyaml YAML parser and emitter for Python >=5.1 6.0.1 MIT pyyaml-env-tag A custom YAML tag for referencing environment variables in YAML files. >=0.1 0.1 MIT License readtime Calculates the time some text takes the average human to read, based on Medium's read time forumula >=2.0 3.0.0 BSD regex Alternative regular expression module, to replace re. >=2022.4.24 2023.8.8 Apache Software License requests Python HTTP for Humans. 2.31.0 Apache 2.0 ruamel-yaml ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order >=0.17.21 0.17.32 MIT license ruamel-yaml-clib C version of reader, parser and emitter for ruamel.yaml derived from libyaml >=0.2.7; platform_python_implementation == \"CPython\" and python_version < \"3.12\" 0.2.7 MIT ruff An extremely fast Python linter, written in Rust. >=0.0.246 0.0.287 MIT safety Checks installed dependencies for known vulnerabilities and licenses. >=2 2.3.4 MIT license semver Python helper for Semantic Versioning (https://semver.org) >=2.13 3.0.1 BSD setuptools Easily download, build, install, upgrade, and uninstall Python packages >=19.3 68.1.2 MIT License six Python 2 and 3 compatibility utilities >=1.5 1.16.0 MIT smmap A pure Python implementation of a sliding window memory map manager <6,>=3.0.1 5.0.0 BSD soupsieve A modern CSS selector implementation for Beautiful Soup. >1.2 2.4.1 MIT License toml Python Library for Tom's Obvious, Minimal Language >=0.10 0.10.2 MIT tomli A lil' TOML parser >=1.1.0; python_version < \"3.11\" 2.0.1 ? types-markdown Typing stubs for Markdown >=3.3 3.4.2.10 Apache-2.0 license types-pyyaml Typing stubs for PyYAML >=6.0 6.0.12.11 Apache-2.0 license types-toml Typing stubs for toml >=0.10 0.10.8.7 Apache-2.0 license typing-extensions Backported and Experimental Type Hints for Python 3.7+ >=3.10.0.0; python_version < \"3.10\" 4.7.1 Python Software Foundation License urllib3 HTTP library with thread-safe connection pooling, file post, and more. <3,>=1.21.1 2.0.4 MIT License watchdog Filesystem events monitoring >=2.0 3.0.0 Apache License 2.0 zipp Backport of pathlib-compatible object wrapper for zip files >=0.5 3.16.2 ? More credits from the author
"},{"location":"license/","title":"License","text":"ISC License\n\nCopyright (c) 2023, Timoth\u00e9e Mazzucotelli\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\nWITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\nANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\nWHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\nACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\nOR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\nMarkdown PyCon follows the sponsorware release strategy, which means that new features are first exclusively released to sponsors as part of Insiders. Read on to learn what sponsorships achieve, how to become a sponsor to get access to Insiders, and what's in it for you!
"},{"location":"insiders/#what-is-insiders","title":"What is Insiders?","text":"Markdown PyCon Insiders is a private fork of Markdown PyCon, hosted as a private GitHub repository. Almost1 all new features are developed as part of this fork, which means that they are immediately available to all eligible sponsors, as they are made collaborators of this repository.
Every feature is tied to a funding goal in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into Markdown PyCon and released for general availability, making them available to all users. Bugfixes are always released in tandem.
Sponsorships start as low as $10 a month.2
"},{"location":"insiders/#what-sponsorships-achieve","title":"What sponsorships achieve","text":"Sponsorships make this project sustainable, as they buy the maintainers of this project time \u2013 a very scarce resource \u2013 which is spent on the development of new features, bug fixing, stability improvement, issue triage and general support. The biggest bottleneck in Open Source is time.3
If you're unsure if you should sponsor this project, check out the list of completed funding goals to learn whether you're already using features that were developed with the help of sponsorships. You're most likely using at least a handful of them, thanks to our awesome sponsors!
"},{"location":"insiders/#whats-in-it-for-me","title":"What's in it for me?","text":"The moment you become a sponsor, you'll get immediate access to 1 additional features that you can start using right away, and which are currently exclusively available to sponsors:
- [Project] Markdown extension to parse
pyconcode blocks without indentation or fences
Thanks for your interest in sponsoring! In order to become an eligible sponsor with your GitHub account, visit pawamoy's sponsor profile, and complete a sponsorship of $10 a month or more. You can use your individual or organization GitHub account for sponsoring.
Important: If you're sponsoring @pawamoy through a GitHub organization, please send a short email to pawamoy@pm.me with the name of your organization and the GitHub account of the individual that should be added as a collaborator.4
You can cancel your sponsorship anytime.5
\u00a0 Join our awesome sponsors
If you sponsor publicly, you're automatically added here with a link to your profile and avatar to show your support for Markdown PyCon. Alternatively, if you wish to keep your sponsorship private, you'll be a silent +1. You can select visibility during checkout and change it afterwards.
"},{"location":"insiders/#funding","title":"Funding","text":""},{"location":"insiders/#goals","title":"Goals","text":"The following section lists all funding goals. Each goal contains a list of features prefixed with a checkmark symbol, denoting whether a feature is already available or planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
"},{"location":"insiders/#1000-gravifridge-user-manual","title":"$ 1,000 \u2014 GraviFridge User Manual","text":"- [Project] Markdown extension to parse
pyconcode blocks without indentation or fences
This section lists all funding goals that were previously completed, which means that those features were part of Insiders, but are now generally available and can be used by all users.
"},{"location":"insiders/#frequently-asked-questions","title":"Frequently asked questions","text":""},{"location":"insiders/#compatibility","title":"Compatibility","text":"We're building an open source project and want to allow outside collaborators to use Markdown PyCon locally without having access to Insiders. Is this still possible?
Yes. Insiders is compatible with Markdown PyCon. Almost all new features and configuration options are either backward-compatible or implemented behind feature flags. Most Insiders features enhance the overall experience, though while these features add value for the users of your project, they shouldn't be necessary for previewing when making changes to content.
"},{"location":"insiders/#payment","title":"Payment","text":"We don't want to pay for sponsorship every month. Are there any other options?
Yes. You can sponsor on a yearly basis by switching your GitHub account to a yearly billing cycle. If for some reason you cannot do that, you could also create a dedicated GitHub account with a yearly billing cycle, which you only use for sponsoring (some sponsors already do that).
If you have any problems or further questions, please reach out to pawamoy@pm.me.
"},{"location":"insiders/#terms","title":"Terms","text":"Are we allowed to use Insiders under the same terms and conditions as Markdown PyCon?
Yes. Whether you're an individual or a company, you may use Markdown PyCon Insiders precisely under the same terms as Markdown PyCon, which are given by the ISC License. However, we kindly ask you to respect our fair use policy:
-
Please don't distribute the source code of Insiders. You may freely use it for public, private or commercial projects, privately fork or mirror it, but please don't make the source code public, as it would counteract the sponsorware strategy.
-
If you cancel your subscription, you're automatically removed as a collaborator and will miss out on all future updates of Insiders. However, you may use the latest version that's available to you as long as you like. Just remember that GitHub deletes private forks.
-
In general, every new feature is first exclusively released to sponsors, but sometimes upstream dependencies enhance existing features that must be supported by Markdown PyCon.\u00a0\u21a9
-
Note that $10 a month is the minimum amount to become eligible for Insiders. While GitHub Sponsors also allows to sponsor lower amounts or one-time amounts, those can't be granted access to Insiders due to technical reasons. Such contributions are still very much welcome as they help ensuring the project's sustainability.\u00a0\u21a9
-
Making an Open Source project sustainable is exceptionally hard: maintainers burn out, projects are abandoned. That's not great and very unpredictable. The sponsorware model ensures that if you decide to use Markdown PyCon, you can be sure that bugs are fixed quickly and new features are added regularly.\u00a0\u21a9
-
It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to pawamoy@pm.me, stating which account should become a collaborator of the Insiders repository. We're working on a solution which will make access to organizations much simpler. To ensure that access is not tied to a particular individual GitHub account, create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being added to the list of collaborators, the bot account can create a private fork of the private Insiders GitHub repository, and grant access to all members of the organizations.\u00a0\u21a9
-
If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable.\u00a0\u21a9
- Release first Insiders version
Markdown PyCon Insiders is a compatible drop-in replacement for Markdown PyCon, and can be installed similarly using pip or git. Note that in order to access the Insiders repository, you need to become an eligible sponsor of @pawamoy on GitHub.
PyPI Insiders is a tool that helps you keep up-to-date versions of Insiders projects in the PyPI index of your choice (self-hosted, Google registry, Artifactory, etc.).
See how to install it and how to use it.
"},{"location":"insiders/installation/#with-pip-sshhttps","title":"with pip (ssh/https)","text":"Markdown PyCon Insiders can be installed with pip using SSH:
pip install git+ssh://git@github.com/pawamoy-insiders/markdown-pycon.git\nOr using HTTPS:
pip install git+https://${GH_TOKEN}@github.com/pawamoy-insiders/markdown-pycon.git\nThe GH_TOKEN environment variable is a GitHub token. It can be obtained by creating a personal access token for your GitHub account. It will give you access to the Insiders repository, programmatically, from the command line or GitHub Actions workflows:
- Go to https://github.com/settings/tokens
- Click on Generate a new token
- Enter a name and select the
reposcope - Generate the token and store it in a safe place
Note that the personal access token must be kept secret at all times, as it allows the owner to access your private repositories.
"},{"location":"insiders/installation/#with-pip-self-hosted","title":"with pip (self-hosted)","text":"Self-hosting the Insiders package makes it possible to depend on Markdown PyCon normally, while transparently downloading and installing the Insiders version locally. It means that you can specify your dependencies normally, and your contributors without access to Insiders will get the public version, while you get the Insiders version on your machine.
Limitation
With this method, there is no way to force the installation of an Insiders version rather than a public version. If there is a public version that is more recent than your self-hosted Insiders version, the public version will take precedence. Remember to regularly update your self-hosted versions by uploading latest distributions.
You can build the distributions for Insiders yourself, by cloning the repository and using build to build the distributions, or you can download them from our GitHub Releases. You can upload these distributions to a private PyPI-like registry (Artifactory, Google Cloud, pypiserver, etc.) with Twine:
# download distributions in ~/dists, then upload with:\ntwine upload --repository-url https://your-private-index.com ~/dists/*\nYou might also need to provide a username and password/token to authenticate against the registry. Please check Twine's documentation.
You can then configure pip (or other tools) to look for packages into your package index. For example, with pip:
pip config set global.extra-index-url https://your-private-index.com/simple\nNote that the URL might differ depending on whether your are uploading a package (with Twine) or installing a package (with pip), and depending on the registry you are using (Artifactory, Google Cloud, etc.). Please check the documentation of your registry to learn how to configure your environment.
We kindly ask that you do not upload the distributions to public registries, as it is against our Terms of use.
Full example withpypiserver In this example we use pypiserver to serve a local PyPI index.
pip install --user pypiserver\n# or pipx install pypiserver\n\n# create a packages directory\nmkdir -p ~/.local/pypiserver/packages\n\n# run the pypi server without authentication\npypi-server run -p 8080 -a . -P . ~/.local/pypiserver/packages &\nWe can configure the credentials to access the server in ~/.pypirc:
[distutils]\nindex-servers =\nlocal\n\n[local]\nrepository: http://localhost:8080\nusername:\npassword:\nWe then clone the Insiders repository, build distributions and upload them to our local server:
# clone the repository\ngit clone git@github.com:pawamoy-insiders/markdown-pycon\ncd markdown-pycon\n\n# install build\npip install --user build\n# or pipx install build\n\n# checkout latest tag\ngit checkout $(git describe --tags --abbrev=0)\n\n# build the distributions\npyproject-build\n\n# upload them to our local server\ntwine upload -r local dist/* --skip-existing\nFinally, we configure pip, and for example PDM, to use our local index to find packages:
pip config set global.extra-index-url http://localhost:8080/simple\npdm config pypi.extra.url http://localhost:8080/simple\nNow when running pip install markdown-pycon, or resolving dependencies with PDM, both tools will look into our local index and find the Insiders version. Remember to update your local index regularly!
Of course, you can use Markdown PyCon Insiders directly from git:
git clone git@github.com:pawamoy-insiders/markdown-pycon\nWhen cloning from git, the package must be installed:
pip install -e markdown-pycon\nWhen upgrading Insiders, you should always check the version of Markdown PyCon which makes up the first part of the version qualifier. For example, a version like 8.x.x.4.x.x means that Insiders 4.x.x is currently based on 8.x.x.
If the major version increased, it's a good idea to consult the changelog and go through the steps to ensure your configuration is up to date and all necessary changes have been made.
"},{"location":"reference/markdown_pycon/","title":"Markdown PyCon package.
Markdown extension to parse pycon code blocks without indentation or fences.
Bases: BlockProcessor
Our block processor.
"},{"location":"reference/markdown_pycon/#markdown_pycon.PyConExtension","title":"PyConExtension","text":" Bases: Extension
Our Markdown extension.
"},{"location":"reference/markdown_pycon/#markdown_pycon.PyConExtension.extendMarkdown","title":"extendMarkdown","text":"extendMarkdown(md: Markdown) -> None\nRegister the block processor.
Add an instance of our PyConBlockProcessor to the Markdown parser.
Parameters:
- md (
Markdown) \u2013A Markdown instance.
makeExtension(*args: Any, **kwargs: Any) -> PyConExtension\nReturn extension.
"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Markdown PyCon","text":"Markdown extension to parse pycon code blocks without indentation or fences.
This project is available to sponsors only, through my Insiders program. See Insiders explanation and installation instructions.
"},{"location":"#configuration","title":"Configuration","text":"This extension relies on the Highlight extension of PyMdown Extensions.
Configure from Python:
from markdown import Markdown\n\nMarkdown(extensions=[\"pycon\"])\n...or in MkDocs configuration file, as a Markdown extension:
# mkdocs.yml\nmarkdown_extensions:\n- pycon\nIn your Markdown documents, simply write your pycon code blocks without indentation or fences (triple backticks):
>>> print(\"This is a pycon code block\")\nThis is a pycon code block\nThis will get rendered as:
>>> print(\"This is a pycon code block\")\nThis is a pycon code block\nDoctest flags will be removed from the code lines.
"},{"location":"changelog/","title":"Changelog","text":"All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
"},{"location":"code_of_conduct/","title":"Contributor Covenant Code of Conduct","text":""},{"location":"code_of_conduct/#our-pledge","title":"Our Pledge","text":"We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
"},{"location":"code_of_conduct/#our-standards","title":"Our Standards","text":"Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
"},{"location":"code_of_conduct/#scope","title":"Scope","text":"This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
"},{"location":"code_of_conduct/#enforcement","title":"Enforcement","text":"Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dev@pawamoy.fr. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
"},{"location":"code_of_conduct/#enforcement-guidelines","title":"Enforcement Guidelines","text":"Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
"},{"location":"code_of_conduct/#1-correction","title":"1. Correction","text":"Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
"},{"location":"code_of_conduct/#2-warning","title":"2. Warning","text":"Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
"},{"location":"code_of_conduct/#3-temporary-ban","title":"3. Temporary Ban","text":"Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
"},{"location":"code_of_conduct/#4-permanent-ban","title":"4. Permanent Ban","text":"Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
"},{"location":"code_of_conduct/#attribution","title":"Attribution","text":"This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
"},{"location":"contributing/","title":"Contributing","text":"Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
"},{"location":"contributing/#environment-setup","title":"Environment setup","text":"Nothing easier!
Fork and clone the repository, then:
cd markdown-pycon\nmake setup\nNote
If it fails for some reason, you'll need to install uv manually.
You can install it with:
python3 -m pip install --user pipx\npipx install uv\nNow you can try running make setup again, or simply uv install.
You now have the dependencies installed.
Run make help to see all the available actions!
This project uses duty to run tasks. A Makefile is also provided. The Makefile will try to run certain tasks on multiple Python versions. If for some reason you don't want to run the task on multiple Python versions, you run the task directly with make run duty TASK.
The Makefile detects if a virtual environment is activated, so make will work the same with the virtualenv activated or not.
If you work in VSCode, we provide an action to configure VSCode for the project.
"},{"location":"contributing/#development","title":"Development","text":"As usual:
- create a new branch:
git switch -c feature-or-bugfix-name - edit the code and/or the documentation
Before committing:
- run
make formatto auto-format the code - run
make checkto check everything (fix any warning) - run
make testto run the tests (fix any issue) - if you updated the documentation or the project dependencies:
- run
make docs - go to http://localhost:8000 and check that everything looks good
- run
- follow our commit message convention
If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
Don't bother updating the changelog, we will take care of this.
"},{"location":"contributing/#commit-message-convention","title":"Commit message convention","text":"Commit messages must follow our convention based on the Angular style or the Karma convention:
<type>[(scope)]: Subject\n\n[Body]\nSubject and body must be valid Markdown. Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general.
Scope and body are optional. Type can be:
build: About packaging, building wheels, etc.chore: About packaging or repo/files management.ci: About Continuous Integration.deps: Dependencies update.docs: About documentation.feat: New feature.fix: Bug fix.perf: About performance.refactor: Changes that are not features or bug fixes.style: A change in code style/format.tests: About tests.
If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown:
Body.\n\nIssue #10: https://github.com/namespace/project/issues/10\nRelated to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15\nThese \"trailers\" must appear at the end of the body, without any blank lines between them. The trailer title can contain any character except colons :. We expect a full URI for each trailer, not just GitHub autolinks (for example, full GitHub URLs for commits and issues, not the hash or the #issue-number).
We do not enforce a line length on commit messages summary and body, but please avoid very long summaries, and very long lines in the body, unless they are part of code blocks that must not be wrapped.
"},{"location":"contributing/#pull-requests-guidelines","title":"Pull requests guidelines","text":"Link to any related issue in the Pull Request message.
During the review, we recommend using fixups:
# SHA is the SHA of the commit you want to fix\ngit commit --fixup=SHA\nOnce all the changes are approved, you can squash your commits:
git rebase -i --autosquash main\nAnd force-push:
git push -f\nIf this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging.
"},{"location":"credits/","title":"Credits","text":""},{"location":"credits/#exec-1--credits","title":"Credits","text":"These projects were used to build markdown-pycon. Thank you!
Python | uv | copier-uv
"},{"location":"credits/#exec-1--development-dependencies","title":"Development dependencies","text":"Project Summary Version (accepted) Version (last resolved) License Babel Internationalization utilities~=2.10 2.14.0 BSD-3-Clause GitPython GitPython is a Python library used to interact with Git repositories 3.1.42 BSD-3-Clause Jinja2 A very fast and expressive template engine. >=2.11.1 3.1.3 BSD-3-Clause Markdown Python implementation of John Gruber's Markdown. >=3.3 3.5.2 BSD License MarkupSafe Safely add untrusted strings to HTML/XML markup. >=1.1 2.1.5 BSD-3-Clause PyYAML YAML parser and emitter for Python >=5.1 6.0.1 MIT Pygments Pygments is a syntax highlighting package written in Python. >=2.13.0, <3.0.0 2.17.2 BSD-2-Clause SecretStorage Python bindings to FreeDesktop.org Secret Service API >=3.2 3.3.3 BSD 3-Clause License ansimarkup Produce colored terminal text with an xml-like markup ~=1.4 1.5.0 Revised BSD License appdirs A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\". >=1.4 1.4.4 MIT black The uncompromising code formatter. >=23.9 24.3.0 MIT blacken-docs Run Black on Python code blocks in documentation files. >=1.16 1.16.0 MIT build A simple, correct Python build frontend >=1.0 1.1.1 MIT License certifi Python package for providing Mozilla's CA Bundle. >=2017.4.17 2024.2.2 MPL-2.0 cffi Foreign Function Interface for Python calling C code. >=1.12 1.16.0 MIT charset-normalizer The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet. >=2, <4 3.3.2 MIT click Composable command line interface toolkit >=7.0 8.1.7 BSD-3-Clause colorama Cross-platform colored terminal text. 0.4.6 BSD License coverage Code coverage measurement for Python >=5.2.1 7.4.4 Apache-2.0 cryptography cryptography is a package which provides cryptographic recipes and primitives to Python developers. >=2.0 42.0.5 Apache-2.0 OR BSD-3-Clause csscompressor A python port of YUI CSS Compressor >=0.9.5 0.9.5 BSD docutils Docutils -- Python Documentation Utilities >=0.13.1 0.20.1 public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt) dparse A parser for Python dependency files >=0.6.2 0.6.3 MIT license duty A simple task runner. >=0.10 1.2.0 ISC execnet execnet: rapid multi-Python deployment >=1.1 2.0.2 MIT failprint Run a command, print its output only if it fails. >=0.11, !=1.0.0 1.0.2 ISC ghp-import Copy your docs directly to the gh-pages branch. >=1.0 2.1.0 Apache Software License git-changelog Automatic Changelog generator using Jinja2 templates. >=2.3 2.4.1 ISC gitdb Git Object Database >=4.0.1, <5 4.0.11 BSD License griffe Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API. >=0.40 0.42.0.1.2.0 ISC htmlmin2 An HTML Minifier >=0.1.13 0.1.13 BSD idna Internationalized Domain Names in Applications (IDNA) >=2.5, <4 3.6 BSD License importlib_metadata Read metadata from Python packages >=4.6 7.0.2 Apache Software License iniconfig brain-dead simple config-ini parsing 2.0.0 MIT jaraco.classes Utility functions for Python class constructs 3.3.1 MIT License jeepney Low-level, pure Python DBus protocol wrapper. >=0.4.2 0.8.0 MIT License jsmin JavaScript minifier. >=3.0.1 3.0.1 MIT License keyring Store and access your passwords safely. >=15.1 24.3.1 MIT License markdown-callouts Markdown extension: a classier syntax for admonitions >=0.3 0.4.0 MIT markdown-exec Utilities to execute code blocks in Markdown files. >=1.7 1.7.0.1.0.1 ISC markdown-it-py Python port of markdown-it. Markdown parsing, done right! >=2.2.0 3.0.0 MIT License mdurl Markdown URL utilities ~=0.1 0.1.2 MIT License mergedeep A deep merge function for \ud83d\udc0d. >=1.3.4 1.3.4 MIT License mkdocs Project documentation with Markdown. >=1.5 1.5.3 BSD-2-Clause mkdocs-autorefs Automatically link across pages in MkDocs. >=0.3.1 1.0.1 ISC mkdocs-coverage MkDocs plugin to integrate your coverage HTML report into your site. >=1.0 1.0.0 ISC mkdocs-gen-files MkDocs plugin to programmatically generate documentation pages during the build >=0.5 0.5.0 MIT mkdocs-git-committers-plugin-2 An MkDocs plugin to create a list of contributors on the page. The git-committers plugin will seed the template context with a list of GitHub or GitLab committers and other useful GIT info such as last modified date >=1.2 2.3.0 MIT mkdocs-literate-nav MkDocs plugin to specify the navigation in Markdown instead of YAML >=0.6 0.6.1 MIT mkdocs-material Documentation that simply works >=9.4 9.5.14+insiders.4.53.2 MIT mkdocs-material-extensions Extension pack for Python Markdown and MkDocs Material. ~=1.3 1.3.1 MIT mkdocs-minify-plugin An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk >=0.7 0.8.0 MIT mkdocstrings Automatic documentation from sources, for MkDocs. >=0.23 0.24.1 ISC mkdocstrings-python A Python handler for mkdocstrings. >=0.5.2 1.9.0.1.6.0 ISC more-itertools More routines for operating on iterables, beyond itertools 10.2.0 MIT License mypy Optional static typing for Python >=1.5 1.9.0 MIT mypy-extensions Type system extensions for programs checked with the mypy type checker. >=1.0.0 1.0.0 MIT License nh3 Python bindings to the ammonia HTML sanitization library. >=0.2.14 0.2.15 MIT packaging Core utilities for Python packages 24.0 Apache Software License + BSD License paginate Divides large result sets into pages for easier browsing ~=0.5 0.5.6 MIT pathspec Utility library for gitignore style pattern matching of file paths. >=0.11.1 0.12.1 Mozilla Public License 2.0 (MPL 2.0) pkginfo Query metadata from sdists / bdists / installed packages. >=1.8.1 1.10.0 MIT platformdirs A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\". >=2.2.0 4.2.0 MIT pluggy plugin and hook calling mechanisms for python >=1.4, <2.0 1.4.0 MIT ptyprocess Run a subprocess in a pseudo terminal ~=0.6 0.7.0 ISC License (ISCL) pycparser C parser in Python 2.21 BSD pymdown-extensions Extension pack for Python Markdown. >=6.3 10.7.1 MIT pyproject_hooks Wrappers to call pyproject.toml-based build backend hooks. 1.0.0 MIT License pytest pytest: simple powerful testing with Python >=7.4 8.1.1 MIT pytest-cov Pytest plugin for measuring coverage. >=4.1 4.1.0 MIT pytest-randomly Pytest plugin to randomly order tests and control random.seed. >=3.15 3.15.0 MIT pytest-xdist pytest xdist plugin for distributed testing, most importantly across multiple CPUs >=3.3 3.5.0 MIT python-dateutil Extensions to the standard Python datetime module >=2.8.1 2.9.0.post0 BSD License + Apache Software License pyyaml_env_tag A custom YAML tag for referencing environment variables in YAML files. >=0.1 0.1 MIT License readme_renderer readme_renderer is a library for rendering readme descriptions for Warehouse >=35.0 43.0 Apache License, Version 2.0 regex Alternative regular expression module, to replace re. >=2022.4 2023.12.25 Apache Software License requests Python HTTP for Humans. 2.31.0 Apache 2.0 requests-toolbelt A utility belt for advanced users of python-requests >=0.8.0, !=0.9.0 1.0.0 Apache 2.0 rfc3986 Validating URI References per RFC 3986 >=1.4.0 2.0.0 Apache 2.0 rich Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal >=12.0.0 13.7.1 MIT ruamel.yaml ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order >=0.17.21 0.18.6 MIT license ruamel.yaml.clib C version of reader, parser and emitter for ruamel.yaml derived from libyaml >=0.2.7 0.2.8 MIT ruff An extremely fast Python linter and code formatter, written in Rust. >=0.0 0.3.3 MIT safety Checks installed dependencies for known vulnerabilities and licenses. >=2.3 2.3.4 MIT license semver Python helper for Semantic Versioning (https://semver.org) >=2.13 3.0.2 BSD setuptools Easily download, build, install, upgrade, and uninstall Python packages >=19.3 69.2.0 MIT License six Python 2 and 3 compatibility utilities >=1.5 1.16.0 MIT smmap A pure Python implementation of a sliding window memory map manager >=3.0.1, <6 5.0.1 BSD twine Collection of utilities for publishing packages on PyPI >=5.0 5.0.0 Apache Software License types-Markdown Typing stubs for Markdown >=3.5 3.6.0.20240316 Apache-2.0 license types-PyYAML Typing stubs for PyYAML >=6.0 6.0.12.20240311 Apache-2.0 license typing_extensions Backported and Experimental Type Hints for Python 3.8+ >=4.1 4.10.0 Python Software Foundation License urllib3 HTTP library with thread-safe connection pooling, file post, and more. >=1.26.0 2.2.1 MIT License watchdog Filesystem events monitoring >=2.0 4.0.0 Apache-2.0 zipp Backport of pathlib-compatible object wrapper for zip files >=0.5 3.18.1 MIT License More credits from the author
"},{"location":"license/","title":"License","text":"ISC License\n\nCopyright (c) 2023, Timoth\u00e9e Mazzucotelli\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\nWITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\nANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\nWHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\nACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\nOR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\nMarkdown PyCon follows the sponsorware release strategy, which means that new features are first exclusively released to sponsors as part of Insiders. Read on to learn what sponsorships achieve, how to become a sponsor to get access to Insiders, and what's in it for you!
"},{"location":"insiders/#what-is-insiders","title":"What is Insiders?","text":"Markdown PyCon Insiders is a private fork of Markdown PyCon, hosted as a private GitHub repository. Almost1 all new features are developed as part of this fork, which means that they are immediately available to all eligible sponsors, as they are made collaborators of this repository.
Every feature is tied to a funding goal in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into Markdown PyCon and released for general availability, making them available to all users. Bugfixes are always released in tandem.
Sponsorships start as low as $10 a month.2
"},{"location":"insiders/#what-sponsorships-achieve","title":"What sponsorships achieve","text":"Sponsorships make this project sustainable, as they buy the maintainers of this project time \u2013 a very scarce resource \u2013 which is spent on the development of new features, bug fixing, stability improvement, issue triage and general support. The biggest bottleneck in Open Source is time.3
If you're unsure if you should sponsor this project, check out the list of completed funding goals to learn whether you're already using features that were developed with the help of sponsorships. You're most likely using at least a handful of them, thanks to our awesome sponsors!
"},{"location":"insiders/#whats-in-it-for-me","title":"What's in it for me?","text":"The moment you become a sponsor, you'll get immediate access to 1 additional features that you can start using right away, and which are currently exclusively available to sponsors:
- [Project] Markdown extension to parse
pyconcode blocks without indentation or fences
These are just the features related to this project. See the complete feature list on the author's main Insiders page.
"},{"location":"insiders/#how-to-become-a-sponsor","title":"How to become a sponsor","text":"Thanks for your interest in sponsoring! In order to become an eligible sponsor with your GitHub account, visit pawamoy's sponsor profile, and complete a sponsorship of $10 a month or more. You can use your individual or organization GitHub account for sponsoring.
Important: If you're sponsoring @pawamoy through a GitHub organization, please send a short email to insiders@pawamoy.fr with the name of your organization and the GitHub account of the individual that should be added as a collaborator.4
You can cancel your sponsorship anytime.5
\u00a0 Join our awesome sponsors
If you sponsor publicly, you're automatically added here with a link to your profile and avatar to show your support for Markdown PyCon. Alternatively, if you wish to keep your sponsorship private, you'll be a silent +1. You can select visibility during checkout and change it afterwards.
"},{"location":"insiders/#funding","title":"Funding","text":""},{"location":"insiders/#goals","title":"Goals","text":"The following section lists all funding goals. Each goal contains a list of features prefixed with a checkmark symbol, denoting whether a feature is already available or planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
"},{"location":"insiders/#1000-gravifridge-fluid-renewal","title":"$ 1,000 \u2014 GraviFridge Fluid Renewal","text":"- [Project] Markdown extension to parse
pyconcode blocks without indentation or fences
There are no features in this goal for this project. See the features in this goal for all Insiders projects.
"},{"location":"insiders/#2000-fusiondrive-ejection-configuration","title":"$ 2,000 \u2014 FusionDrive Ejection Configuration","text":"There are no features in this goal for this project. See the features in this goal for all Insiders projects.
"},{"location":"insiders/#goals-completed","title":"Goals completed","text":"This section lists all funding goals that were previously completed, which means that those features were part of Insiders, but are now generally available and can be used by all users.
"},{"location":"insiders/#500-plasmavac-user-guide","title":"$ 500 \u2014 PlasmaVac User Guide","text":"There are no features in this goal for this project. See the features in this goal for all Insiders projects.
"},{"location":"insiders/#frequently-asked-questions","title":"Frequently asked questions","text":""},{"location":"insiders/#compatibility","title":"Compatibility","text":"We're building an open source project and want to allow outside collaborators to use Markdown PyCon locally without having access to Insiders. Is this still possible?
Yes. Insiders is compatible with Markdown PyCon. Almost all new features and configuration options are either backward-compatible or implemented behind feature flags. Most Insiders features enhance the overall experience, though while these features add value for the users of your project, they shouldn't be necessary for previewing when making changes to content.
"},{"location":"insiders/#payment","title":"Payment","text":"We don't want to pay for sponsorship every month. Are there any other options?
Yes. You can sponsor on a yearly basis by switching your GitHub account to a yearly billing cycle. If for some reason you cannot do that, you could also create a dedicated GitHub account with a yearly billing cycle, which you only use for sponsoring (some sponsors already do that).
If you have any problems or further questions, please reach out to insiders@pawamoy.fr.
"},{"location":"insiders/#terms","title":"Terms","text":"Are we allowed to use Insiders under the same terms and conditions as Markdown PyCon?
Yes. Whether you're an individual or a company, you may use Markdown PyCon Insiders precisely under the same terms as Markdown PyCon, which are given by the ISC License. However, we kindly ask you to respect our fair use policy:
-
Please don't distribute the source code of Insiders. You may freely use it for public, private or commercial projects, privately fork or mirror it, but please don't make the source code public, as it would counteract the sponsorware strategy.
-
If you cancel your subscription, you're automatically removed as a collaborator and will miss out on all future updates of Insiders. However, you may use the latest version that's available to you as long as you like. Just remember that GitHub deletes private forks.
-
In general, every new feature is first exclusively released to sponsors, but sometimes upstream dependencies enhance existing features that must be supported by Markdown PyCon.\u00a0\u21a9
-
Note that $10 a month is the minimum amount to become eligible for Insiders. While GitHub Sponsors also allows to sponsor lower amounts or one-time amounts, those can't be granted access to Insiders due to technical reasons. Such contributions are still very much welcome as they help ensuring the project's sustainability.\u00a0\u21a9
-
Making an Open Source project sustainable is exceptionally hard: maintainers burn out, projects are abandoned. That's not great and very unpredictable. The sponsorware model ensures that if you decide to use Markdown PyCon, you can be sure that bugs are fixed quickly and new features are added regularly.\u00a0\u21a9
-
It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to insiders@pawamoy.fr, stating which account should become a collaborator of the Insiders repository. We're working on a solution which will make access to organizations much simpler. To ensure that access is not tied to a particular individual GitHub account, create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being added to the list of collaborators, the bot account can create a private fork of the private Insiders GitHub repository, and grant access to all members of the organizations.\u00a0\u21a9
-
If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable.\u00a0\u21a9
- Release first Insiders version
Markdown PyCon Insiders is a compatible drop-in replacement for Markdown PyCon, and can be installed similarly using pip or git. Note that in order to access the Insiders repository, you need to become an eligible sponsor of @pawamoy on GitHub.
PyPI Insiders is a tool that helps you keep up-to-date versions of Insiders projects in the PyPI index of your choice (self-hosted, Google registry, Artifactory, etc.).
See how to install it and how to use it.
"},{"location":"insiders/installation/#with-pip-sshhttps","title":"with pip (ssh/https)","text":"Markdown PyCon Insiders can be installed with pip using SSH:
pip install git+ssh://git@github.com/pawamoy-insiders/markdown-pycon.git\nOr using HTTPS:
pip install git+https://${GH_TOKEN}@github.com/pawamoy-insiders/markdown-pycon.git\nThe GH_TOKEN environment variable is a GitHub token. It can be obtained by creating a personal access token for your GitHub account. It will give you access to the Insiders repository, programmatically, from the command line or GitHub Actions workflows:
- Go to https://github.com/settings/tokens
- Click on Generate a new token
- Enter a name and select the
reposcope - Generate the token and store it in a safe place
Note that the personal access token must be kept secret at all times, as it allows the owner to access your private repositories.
"},{"location":"insiders/installation/#with-pip-self-hosted","title":"with pip (self-hosted)","text":"Self-hosting the Insiders package makes it possible to depend on Markdown PyCon normally, while transparently downloading and installing the Insiders version locally. It means that you can specify your dependencies normally, and your contributors without access to Insiders will get the public version, while you get the Insiders version on your machine.
Limitation
With this method, there is no way to force the installation of an Insiders version rather than a public version. If there is a public version that is more recent than your self-hosted Insiders version, the public version will take precedence. Remember to regularly update your self-hosted versions by uploading latest distributions.
You can build the distributions for Insiders yourself, by cloning the repository and using build to build the distributions, or you can download them from our GitHub Releases. You can upload these distributions to a private PyPI-like registry (Artifactory, Google Cloud, pypiserver, etc.) with Twine:
# download distributions in ~/dists, then upload with:\ntwine upload --repository-url https://your-private-index.com ~/dists/*\nYou might also need to provide a username and password/token to authenticate against the registry. Please check Twine's documentation.
You can then configure pip (or other tools) to look for packages into your package index. For example, with pip:
pip config set global.extra-index-url https://your-private-index.com/simple\nNote that the URL might differ depending on whether your are uploading a package (with Twine) or installing a package (with pip), and depending on the registry you are using (Artifactory, Google Cloud, etc.). Please check the documentation of your registry to learn how to configure your environment.
We kindly ask that you do not upload the distributions to public registries, as it is against our Terms of use.
Full example withpypiserver In this example we use pypiserver to serve a local PyPI index.
pip install --user pypiserver\n# or pipx install pypiserver\n\n# create a packages directory\nmkdir -p ~/.local/pypiserver/packages\n\n# run the pypi server without authentication\npypi-server run -p 8080 -a . -P . ~/.local/pypiserver/packages &\nWe can configure the credentials to access the server in ~/.pypirc:
[distutils]\nindex-servers =\n local\n\n[local]\nrepository: http://localhost:8080\nusername:\npassword:\nWe then clone the Insiders repository, build distributions and upload them to our local server:
# clone the repository\ngit clone git@github.com:pawamoy-insiders/markdown-pycon\ncd markdown-pycon\n\n# install build\npip install --user build\n# or pipx install build\n\n# checkout latest tag\ngit checkout $(git describe --tags --abbrev=0)\n\n# build the distributions\npyproject-build\n\n# upload them to our local server\ntwine upload -r local dist/* --skip-existing\nFinally, we configure pip, and for example PDM, to use our local index to find packages:
pip config set global.extra-index-url http://localhost:8080/simple\npdm config pypi.extra.url http://localhost:8080/simple\nNow when running pip install markdown-pycon, or resolving dependencies with PDM, both tools will look into our local index and find the Insiders version. Remember to update your local index regularly!
Of course, you can use Markdown PyCon Insiders directly from git:
git clone git@github.com:pawamoy-insiders/markdown-pycon\nWhen cloning from git, the package must be installed:
pip install -e markdown-pycon\nWhen upgrading Insiders, you should always check the version of Markdown PyCon which makes up the first part of the version qualifier. For example, a version like 8.x.x.4.x.x means that Insiders 4.x.x is currently based on 8.x.x.
If the major version increased, it's a good idea to consult the changelog and go through the steps to ensure your configuration is up to date and all necessary changes have been made.
"},{"location":"reference/SUMMARY/","title":"SUMMARY","text":"- markdown_pycon
- debug
Markdown PyCon package.
Markdown extension to parse pycon code blocks without indentation or fences.
Modules:
-
debug\u2013Debugging utilities.
Classes:
-
PyConBlockProcessor\u2013Our block processor.
-
PyConExtension\u2013Our Markdown extension.
Functions:
-
makeExtension\u2013Return extension.
Bases: BlockProcessor
Our block processor.
"},{"location":"reference/markdown_pycon/#markdown_pycon.PyConExtension","title":"PyConExtension","text":" Bases: Extension
Our Markdown extension.
Methods:
-
extendMarkdown\u2013Register the block processor.
extendMarkdown(md: Markdown) -> None\nRegister the block processor.
Add an instance of our PyConBlockProcessor to the Markdown parser.
Parameters:
-
md(Markdown) \u2013A Markdown instance.
makeExtension(*args: Any, **kwargs: Any) -> PyConExtension\nReturn extension.
"},{"location":"reference/markdown_pycon/debug/","title":"Debugging utilities.
Classes:
-
Environment\u2013Dataclass to store environment information.
-
Package\u2013Dataclass describing a Python package.
-
Variable\u2013Dataclass describing an environment variable.
Functions:
-
get_debug_info\u2013Get debug/environment information.
-
get_version\u2013Get version of the given distribution.
-
print_debug_info\u2013Print debug/environment information.
dataclass","text":"Environment(\n interpreter_name: str,\n interpreter_version: str,\n interpreter_path: str,\n platform: str,\n packages: list[Package],\n variables: list[Variable],\n)\nDataclass to store environment information.
Attributes:
-
interpreter_name(str) \u2013Python interpreter name.
-
interpreter_path(str) \u2013Path to Python executable.
-
interpreter_version(str) \u2013Python interpreter version.
-
packages(list[Package]) \u2013Installed packages.
-
platform(str) \u2013Operating System.
-
variables(list[Variable]) \u2013Environment variables.
instance-attribute","text":"interpreter_name: str\nPython interpreter name.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Environment.interpreter_path","title":"interpreter_pathinstance-attribute","text":"interpreter_path: str\nPath to Python executable.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Environment.interpreter_version","title":"interpreter_versioninstance-attribute","text":"interpreter_version: str\nPython interpreter version.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Environment.packages","title":"packagesinstance-attribute","text":"packages: list[Package]\nInstalled packages.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Environment.platform","title":"platforminstance-attribute","text":"platform: str\nOperating System.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Environment.variables","title":"variablesinstance-attribute","text":"variables: list[Variable]\nEnvironment variables.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Package","title":"Packagedataclass","text":"Package(name: str, version: str)\nDataclass describing a Python package.
Attributes:
-
name(str) \u2013Package name.
-
version(str) \u2013Package version.
instance-attribute","text":"name: str\nPackage name.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Package.version","title":"versioninstance-attribute","text":"version: str\nPackage version.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Variable","title":"Variabledataclass","text":"Variable(name: str, value: str)\nDataclass describing an environment variable.
Attributes:
-
name(str) \u2013Variable name.
-
value(str) \u2013Variable value.
instance-attribute","text":"name: str\nVariable name.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.Variable.value","title":"valueinstance-attribute","text":"value: str\nVariable value.
"},{"location":"reference/markdown_pycon/debug/#markdown_pycon.debug.get_debug_info","title":"get_debug_info","text":"get_debug_info() -> Environment\nGet debug/environment information.
Returns:
-
Environment\u2013Environment information.
get_version(dist: str = 'markdown-pycon') -> str\nGet version of the given distribution.
Parameters:
-
dist(str, default:'markdown-pycon') \u2013A distribution name.
Returns:
-
str\u2013A version number.
print_debug_info() -> None\nPrint debug/environment information.
"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 9e0e3a5..910e26e 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,52 +2,62 @@