markdown-exec 1.10.1__tar.gz → 1.10.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/CHANGELOG.md +13 -0
  2. markdown_exec-1.10.2/CODE_OF_CONDUCT.md +84 -0
  3. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/CONTRIBUTING.md +13 -41
  4. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/PKG-INFO +4 -3
  5. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/config/ruff.toml +9 -2
  6. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/config/vscode/launch.json +11 -1
  7. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/.overrides/partials/comments.html +1 -1
  8. markdown_exec-1.10.2/docs/.overrides/partials/path-item.html +22 -0
  9. markdown_exec-1.10.2/docs/changelog.md +5 -0
  10. markdown_exec-1.10.2/docs/code_of_conduct.md +5 -0
  11. markdown_exec-1.10.2/docs/contributing.md +5 -0
  12. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/credits.md +1 -2
  13. markdown_exec-1.10.2/docs/css/mkdocstrings.css +72 -0
  14. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/gallery.md +0 -12
  15. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/index.md +1 -0
  16. markdown_exec-1.10.2/docs/insiders/index.md +157 -0
  17. markdown_exec-1.10.2/docs/insiders/installation.md +67 -0
  18. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/license.md +1 -0
  19. markdown_exec-1.10.2/docs/reference/api.md +9 -0
  20. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/duties.py +30 -10
  21. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/mkdocs.yml +13 -11
  22. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/pyproject.toml +23 -12
  23. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/scripts/gen_credits.py +2 -2
  24. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/scripts/get_version.py +1 -2
  25. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/scripts/insiders.py +4 -37
  26. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/scripts/make.py +0 -2
  27. markdown_exec-1.10.2/src/markdown_exec/__init__.py +55 -0
  28. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/debug.py +13 -15
  29. markdown_exec-1.10.2/src/markdown_exec/_internal/formatters/__init__.py +1 -0
  30. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/_exec_python.py +1 -1
  31. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/base.py +10 -7
  32. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/bash.py +3 -3
  33. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/console.py +5 -5
  34. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/markdown.py +2 -2
  35. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/pycon.py +3 -6
  36. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/pyodide.py +12 -9
  37. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/python.py +4 -4
  38. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/sh.py +3 -3
  39. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/formatters/tree.py +2 -2
  40. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/logger.py +28 -31
  41. markdown_exec-1.10.1/src/markdown_exec/__init__.py → markdown_exec-1.10.2/src/markdown_exec/_internal/main.py +12 -32
  42. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/mkdocs_plugin.py +14 -12
  43. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/processors.py +20 -7
  44. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/_internal}/rendering.py +14 -10
  45. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/assets}/pyodide.js +12 -6
  46. markdown_exec-1.10.2/src/markdown_exec/formatters/__init__.py +17 -0
  47. markdown_exec-1.10.2/src/markdown_exec/formatters/base.py +17 -0
  48. markdown_exec-1.10.2/src/markdown_exec/formatters/bash.py +17 -0
  49. markdown_exec-1.10.2/src/markdown_exec/formatters/console.py +17 -0
  50. markdown_exec-1.10.2/src/markdown_exec/formatters/markdown.py +17 -0
  51. markdown_exec-1.10.2/src/markdown_exec/formatters/pycon.py +17 -0
  52. markdown_exec-1.10.2/src/markdown_exec/formatters/pyodide.py +17 -0
  53. markdown_exec-1.10.2/src/markdown_exec/formatters/python.py +17 -0
  54. markdown_exec-1.10.2/src/markdown_exec/formatters/sh.py +17 -0
  55. markdown_exec-1.10.2/src/markdown_exec/formatters/tree.py +17 -0
  56. markdown_exec-1.10.2/src/markdown_exec/logger.py +17 -0
  57. markdown_exec-1.10.2/src/markdown_exec/mkdocs_plugin.py +17 -0
  58. markdown_exec-1.10.2/src/markdown_exec/processors.py +17 -0
  59. markdown_exec-1.10.2/src/markdown_exec/py.typed +0 -0
  60. markdown_exec-1.10.2/src/markdown_exec/rendering.py +17 -0
  61. markdown_exec-1.10.2/tests/test_api.py +203 -0
  62. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/test_base_formatter.py +1 -1
  63. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/test_converter.py +1 -1
  64. markdown_exec-1.10.1/CODE_OF_CONDUCT.md +0 -133
  65. markdown_exec-1.10.1/docs/changelog.md +0 -1
  66. markdown_exec-1.10.1/docs/code_of_conduct.md +0 -1
  67. markdown_exec-1.10.1/docs/contributing.md +0 -1
  68. markdown_exec-1.10.1/docs/css/mkdocstrings.css +0 -27
  69. markdown_exec-1.10.1/docs/insiders/index.md +0 -241
  70. markdown_exec-1.10.1/docs/insiders/installation.md +0 -88
  71. markdown_exec-1.10.1/docs/snippets/gallery/pytermgui.py +0 -39
  72. markdown_exec-1.10.1/scripts/gen_ref_nav.py +0 -37
  73. markdown_exec-1.10.1/src/markdown_exec/formatters/__init__.py +0 -1
  74. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/LICENSE +0 -0
  75. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/README.md +0 -0
  76. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/config/coverage.ini +0 -0
  77. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/config/git-changelog.toml +0 -0
  78. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/config/mypy.ini +0 -0
  79. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/config/pytest.ini +0 -0
  80. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/config/vscode/settings.json +0 -0
  81. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/config/vscode/tasks.json +0 -0
  82. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/.overrides/main.html +0 -0
  83. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/css/insiders.css +0 -0
  84. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/css/material.css +0 -0
  85. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/insiders/changelog.md +0 -0
  86. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/insiders/goals.yml +0 -0
  87. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/js/feedback.js +0 -0
  88. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/js/insiders.js +0 -0
  89. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/schema.json +0 -0
  90. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/ansi.sh +0 -0
  91. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/argparse.py +0 -0
  92. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/argparse_format.py +0 -0
  93. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/chalk.py +0 -0
  94. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/d2.py +0 -0
  95. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/diagrams.py +0 -0
  96. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/drawsvg.py +0 -0
  97. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/expandable_filetree.py +0 -0
  98. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/hyperbolic.py +0 -0
  99. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/matplotlib.py +0 -0
  100. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/plotly.py +0 -0
  101. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/pydeps.py +0 -0
  102. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/qrcode.py +0 -0
  103. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/rich.py +0 -0
  104. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/rich_terminal.py +0 -0
  105. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/runpy.py +0 -0
  106. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/gallery/textual.py +0 -0
  107. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/usage/boolean_matrix.py +0 -0
  108. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/usage/hide.py +0 -0
  109. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/usage/multiple.pycon +0 -0
  110. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/usage/platform_html.py +0 -0
  111. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/usage/platform_md.py +0 -0
  112. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/usage/source.py +0 -0
  113. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/snippets/usage/source.pycon +0 -0
  114. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/usage/index.md +0 -0
  115. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/usage/pyodide.md +0 -0
  116. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/usage/python.md +0 -0
  117. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/usage/shell.md +0 -0
  118. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/docs/usage/tree.md +0 -0
  119. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/scripts/make +0 -0
  120. /markdown_exec-1.10.1/src/markdown_exec/py.typed → /markdown_exec-1.10.2/src/markdown_exec/_internal/__init__.py +0 -0
  121. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/assets}/ansi.css +0 -0
  122. {markdown_exec-1.10.1/src/markdown_exec → markdown_exec-1.10.2/src/markdown_exec/assets}/pyodide.css +0 -0
  123. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/__init__.py +0 -0
  124. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/conftest.py +0 -0
  125. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/test_headings.py +0 -0
  126. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/test_python.py +0 -0
  127. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/test_shell.py +0 -0
  128. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/test_toc.py +0 -0
  129. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/test_tree.py +0 -0
  130. {markdown_exec-1.10.1 → markdown_exec-1.10.2}/tests/test_validator.py +0 -0
@@ -5,6 +5,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5
5
  and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6
6
 
7
7
  <!-- insertion marker -->
8
+ ## [1.10.2](https://github.com/pawamoy/markdown-exec/releases/tag/1.10.2) - 2025-03-18
9
+
10
+ <small>[Compare with 1.10.1](https://github.com/pawamoy/markdown-exec/compare/1.10.1...1.10.2)</small>
11
+
12
+ ### Bug Fixes
13
+
14
+ - Escape Pyodide output, improve error handling ([ec83f48](https://github.com/pawamoy/markdown-exec/commit/ec83f48db29708b03e8d2487ccb0d5ee0889a464) by Timothée Mazzucotelli). [Issue-87](https://github.com/pawamoy/markdown-exec/issues/87)
15
+
16
+ ### Code Refactoring
17
+
18
+ - Sync API and docs ([1245ed9](https://github.com/pawamoy/markdown-exec/commit/1245ed96b8c5d430cc949fcfa2b9f2ef5be78f65) by Timothée Mazzucotelli).
19
+ - Move code under internal folder ([b132e78](https://github.com/pawamoy/markdown-exec/commit/b132e78d2a9ebc48edd7b388e00b161eb0a048b6) by Timothée Mazzucotelli).
20
+
8
21
  ## [1.10.1](https://github.com/pawamoy/markdown-exec/releases/tag/1.10.1) - 2025-03-11
9
22
 
10
23
  <small>[Compare with 1.10.0](https://github.com/pawamoy/markdown-exec/compare/1.10.0...1.10.1)</small>
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ 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.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or advances of any kind
22
+ * Trolling, insulting or derogatory comments, and personal or political attacks
23
+ * Public or private harassment
24
+ * Publishing others' private information, such as a physical or email address, without their explicit permission
25
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
26
+
27
+ ## Enforcement Responsibilities
28
+
29
+ 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.
30
+
31
+ 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.
32
+
33
+ ## Scope
34
+
35
+ 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.
36
+
37
+ ## Enforcement
38
+
39
+ 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.
40
+
41
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42
+
43
+ ## Enforcement Guidelines
44
+
45
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46
+
47
+ ### 1. Correction
48
+
49
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50
+
51
+ **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.
52
+
53
+ ### 2. Warning
54
+
55
+ **Community Impact**: A violation through a single incident or series of actions.
56
+
57
+ **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.
58
+
59
+ ### 3. Temporary Ban
60
+
61
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62
+
63
+ **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.
64
+
65
+ ### 4. Permanent Ban
66
+
67
+ **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.
68
+
69
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
70
+
71
+ ## Attribution
72
+
73
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
74
+
75
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76
+
77
+ For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
78
+
79
+ [homepage]: https://www.contributor-covenant.org
80
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81
+ [Mozilla CoC]: https://github.com/mozilla/diversity
82
+ [FAQ]: https://www.contributor-covenant.org/faq
83
+ [translations]: https://www.contributor-covenant.org/translations
84
+
@@ -1,7 +1,6 @@
1
1
  # Contributing
2
2
 
3
- Contributions are welcome, and they are greatly appreciated!
4
- Every little bit helps, and credit will always be given.
3
+ Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
5
4
 
6
5
  ## Environment setup
7
6
 
@@ -14,11 +13,7 @@ cd markdown-exec
14
13
  make setup
15
14
  ```
16
15
 
17
- > NOTE:
18
- > If it fails for some reason,
19
- > you'll need to install
20
- > [uv](https://github.com/astral-sh/uv)
21
- > manually.
16
+ > NOTE: If it fails for some reason, you'll need to install [uv](https://github.com/astral-sh/uv) manually.
22
17
  >
23
18
  > You can install it with:
24
19
  >
@@ -26,8 +21,7 @@ make setup
26
21
  > curl -LsSf https://astral.sh/uv/install.sh | sh
27
22
  > ```
28
23
  >
29
- > Now you can try running `make setup` again,
30
- > or simply `uv sync`.
24
+ > Now you can try running `make setup` again, or simply `uv sync`.
31
25
 
32
26
  You now have the dependencies installed.
33
27
 
@@ -35,15 +29,10 @@ Run `make help` to see all the available actions!
35
29
 
36
30
  ## Tasks
37
31
 
38
- The entry-point to run commands and tasks is the `make` Python script,
39
- located in the `scripts` directory. Try running `make` to show the available commands and tasks.
40
- The *commands* do not need the Python dependencies to be installed,
41
- while the *tasks* do.
42
- The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
32
+ The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed,
33
+ while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
43
34
 
44
- If you work in VSCode, we provide
45
- [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)
46
- for the project.
35
+ If you work in VSCode, we provide [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) for the project.
47
36
 
48
37
  ## Development
49
38
 
@@ -62,17 +51,13 @@ As usual:
62
51
  1. go to http://localhost:8000 and check that everything looks good
63
52
  1. follow our [commit message convention](#commit-message-convention)
64
53
 
65
- If you are unsure about how to fix or ignore a warning,
66
- just let the continuous integration fail,
67
- and we will help you during review.
54
+ 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.
68
55
 
69
56
  Don't bother updating the changelog, we will take care of this.
70
57
 
71
58
  ## Commit message convention
72
59
 
73
- Commit messages must follow our convention based on the
74
- [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
75
- or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
60
+ Commit messages must follow our convention based on the [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message) or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
76
61
 
77
62
  ```
78
63
  <type>[(scope)]: Subject
@@ -80,10 +65,7 @@ or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.
80
65
  [Body]
81
66
  ```
82
67
 
83
- **Subject and body must be valid Markdown.**
84
- Subject must have proper casing (uppercase for first letter
85
- if it makes sense), but no dot at the end, and no punctuation
86
- in general.
68
+ **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.
87
69
 
88
70
  Scope and body are optional. Type can be:
89
71
 
@@ -99,9 +81,7 @@ Scope and body are optional. Type can be:
99
81
  - `style`: A change in code style/format.
100
82
  - `tests`: About tests.
101
83
 
102
- If you write a body, please add trailers at the end
103
- (for example issues and PR references, or co-authors),
104
- without relying on GitHub's flavored Markdown:
84
+ 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:
105
85
 
106
86
  ```
107
87
  Body.
@@ -110,16 +90,9 @@ Issue #10: https://github.com/namespace/project/issues/10
110
90
  Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
111
91
  ```
112
92
 
113
- These "trailers" must appear at the end of the body,
114
- without any blank lines between them. The trailer title
115
- can contain any character except colons `:`.
116
- We expect a full URI for each trailer, not just GitHub autolinks
117
- (for example, full GitHub URLs for commits and issues,
118
- not the hash or the #issue-number).
93
+ These "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).
119
94
 
120
- We do not enforce a line length on commit messages summary and body,
121
- but please avoid very long summaries, and very long lines in the body,
122
- unless they are part of code blocks that must not be wrapped.
95
+ 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.
123
96
 
124
97
  ## Pull requests guidelines
125
98
 
@@ -144,5 +117,4 @@ And force-push:
144
117
  git push -f
145
118
  ```
146
119
 
147
- If this seems all too complicated, you can push or force-push each new commit,
148
- and we will squash them ourselves if needed, before merging.
120
+ 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.
@@ -1,10 +1,11 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: markdown-exec
3
- Version: 1.10.1
3
+ Version: 1.10.2
4
4
  Summary: Utilities to execute code blocks in Markdown files.
5
5
  Keywords: markdown,python,exec,shell,bash,mkdocs
6
6
  Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
7
- License: ISC
7
+ License-Expression: ISC
8
+ License-File: LICENSE
8
9
  Classifier: Development Status :: 4 - Beta
9
10
  Classifier: Intended Audience :: Developers
10
11
  Classifier: Programming Language :: Python
@@ -47,17 +47,24 @@ ignore = [
47
47
  ]
48
48
 
49
49
  [lint.per-file-ignores]
50
- "src/*/cli.py" = [
50
+ "src/**/cli.py" = [
51
51
  "T201", # Print statement
52
52
  ]
53
53
  "src/*/debug.py" = [
54
54
  "T201", # Print statement
55
55
  ]
56
+ "!src/*/*.py" = [
57
+ "D100", # Missing docstring in public module
58
+ ]
59
+ "!src/**.py" = [
60
+ "D101", # Missing docstring in public class
61
+ "D103", # Missing docstring in public function
62
+ ]
56
63
  "scripts/*.py" = [
57
64
  "INP001", # File is part of an implicit namespace package
58
65
  "T201", # Print statement
59
66
  ]
60
- "tests/*.py" = [
67
+ "tests/**.py" = [
61
68
  "ARG005", # Unused lambda argument
62
69
  "FBT001", # Boolean positional arg in function definition
63
70
  "PLR2004", # Magic value used in comparison
@@ -7,7 +7,17 @@
7
7
  "request": "launch",
8
8
  "program": "${file}",
9
9
  "console": "integratedTerminal",
10
- "justMyCode": false
10
+ "justMyCode": false,
11
+ "args": "${command:pickArgs}"
12
+ },
13
+ {
14
+ "name": "run",
15
+ "type": "debugpy",
16
+ "request": "launch",
17
+ "module": "markdown_exec",
18
+ "console": "integratedTerminal",
19
+ "justMyCode": false,
20
+ "args": "${command:pickArgs}"
11
21
  },
12
22
  {
13
23
  "name": "docs",
@@ -31,7 +31,7 @@
31
31
  : "light"
32
32
 
33
33
  // Instruct Giscus to set theme
34
- giscus.setAttribute("data-theme", theme)
34
+ giscus.setAttribute("data-theme", theme)
35
35
  }
36
36
 
37
37
  // Register event handlers after documented loaded
@@ -0,0 +1,22 @@
1
+ {# Fix breadcrumbs for when mkdocs-section-index is used. #}
2
+ {# See https://github.com/squidfunk/mkdocs-material/issues/7614. #}
3
+
4
+ <!-- Render navigation link content -->
5
+ {% macro render_content(nav_item) %}
6
+ <span class="md-ellipsis">
7
+ {{ nav_item.title }}
8
+ </span>
9
+ {% endmacro %}
10
+
11
+ <!-- Render navigation item -->
12
+ {% macro render(nav_item, ref=nav_item) %}
13
+ {% if nav_item.is_page %}
14
+ <li class="md-path__item">
15
+ <a href="{{ nav_item.url | url }}" class="md-path__link">
16
+ {{ render_content(ref) }}
17
+ </a>
18
+ </li>
19
+ {% elif nav_item.children %}
20
+ {{ render(nav_item.children | first, ref) }}
21
+ {% endif %}
22
+ {% endmacro %}
@@ -0,0 +1,5 @@
1
+ ---
2
+ title: Changelog
3
+ ---
4
+
5
+ --8<-- "CHANGELOG.md"
@@ -0,0 +1,5 @@
1
+ ---
2
+ title: Code of Conduct
3
+ ---
4
+
5
+ --8<-- "CODE_OF_CONDUCT.md"
@@ -0,0 +1,5 @@
1
+ ---
2
+ title: Contributing
3
+ ---
4
+
5
+ --8<-- "CONTRIBUTING.md"
@@ -1,10 +1,9 @@
1
1
  ---
2
+ title: Credits
2
3
  hide:
3
4
  - toc
4
5
  ---
5
6
 
6
- <!-- blacken-docs:off -->
7
7
  ```python exec="yes"
8
8
  --8<-- "scripts/gen_credits.py"
9
9
  ```
10
- <!-- blacken-docs:on -->
@@ -0,0 +1,72 @@
1
+ /* Indentation. */
2
+ div.doc-contents:not(.first) {
3
+ padding-left: 25px;
4
+ border-left: .05rem solid var(--md-typeset-table-color);
5
+ }
6
+
7
+ /* Mark external links as such. */
8
+ a.external::after,
9
+ a.autorefs-external::after {
10
+ /* https://primer.style/octicons/arrow-up-right-24 */
11
+ mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
12
+ -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
13
+ content: ' ';
14
+
15
+ display: inline-block;
16
+ vertical-align: middle;
17
+ position: relative;
18
+
19
+ height: 1em;
20
+ width: 1em;
21
+ background-color: currentColor;
22
+ }
23
+
24
+ a.external:hover::after,
25
+ a.autorefs-external:hover::after {
26
+ background-color: var(--md-accent-fg-color);
27
+ }
28
+
29
+ /* Tree-like output for backlinks. */
30
+ .doc-backlink-list {
31
+ --tree-clr: var(--md-default-fg-color);
32
+ --tree-font-size: 1rem;
33
+ --tree-item-height: 1;
34
+ --tree-offset: 1rem;
35
+ --tree-thickness: 1px;
36
+ --tree-style: solid;
37
+ display: grid;
38
+ list-style: none !important;
39
+ }
40
+
41
+ .doc-backlink-list li > span:first-child {
42
+ text-indent: .3rem;
43
+ }
44
+ .doc-backlink-list li {
45
+ padding-inline-start: var(--tree-offset);
46
+ border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
47
+ position: relative;
48
+ margin-left: 0 !important;
49
+
50
+ &:last-child {
51
+ border-color: transparent;
52
+ }
53
+ &::before{
54
+ content: '';
55
+ position: absolute;
56
+ top: calc(var(--tree-item-height) / 2 * -1 * var(--tree-font-size) + var(--tree-thickness));
57
+ left: calc(var(--tree-thickness) * -1);
58
+ width: calc(var(--tree-offset) + var(--tree-thickness) * 2);
59
+ height: calc(var(--tree-item-height) * var(--tree-font-size));
60
+ border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
61
+ border-bottom: var(--tree-thickness) var(--tree-style) var(--tree-clr);
62
+ }
63
+ &::after{
64
+ content: '';
65
+ position: absolute;
66
+ border-radius: 50%;
67
+ background-color: var(--tree-clr);
68
+ top: calc(var(--tree-item-height) / 2 * 1rem);
69
+ left: var(--tree-offset) ;
70
+ translate: calc(var(--tree-thickness) * -1) calc(var(--tree-thickness) * -1);
71
+ }
72
+ }
@@ -97,18 +97,6 @@ pydeps uses [Graphviz](https://graphviz.org/) under the hood to generate graphs.
97
97
  ```
98
98
  ````
99
99
 
100
- ### with [PyTermGUI](https://github.com/bczsalba/pytermgui)
101
-
102
- > Python TUI framework with mouse support, modular widget system, customizable and rapid terminal markup language and more!
103
-
104
- ````md exec="1" source="tabbed-right"
105
- ```python exec="true" html="true"
106
- --8<-- "gallery/pytermgui.py"
107
- ```
108
- ````
109
-
110
- TIP: There's a PyTermGUI-dedicated MkDocs plugin that allows to generate SVGs on-the-fly: [Termage](https://github.com/bczsalba/Termage). It is implemented using regular expressions in the `on_markdown` event of MkDocs, so is probably less robust than our actual SuperFence implementation here, but also allows for less verbose source to generate the SVG snippets.
111
-
112
100
  ## Console output
113
101
 
114
102
  If you installed Markdown Exec with the `ansi` extra (`pip install markdown-exec[ansi]`), the ANSI colors in the output of shell commands will be translated to HTML/CSS, allowing to render them naturally in your documentation pages. For this to happen, use the [`result="ansi"` option](http://localhost:8000/markdown-exec/usage/#wrap-result-in-a-code-block).
@@ -1,4 +1,5 @@
1
1
  ---
2
+ title: Overview
2
3
  hide:
3
4
  - feedback
4
5
  ---
@@ -0,0 +1,157 @@
1
+ ---
2
+ title: Insiders
3
+ ---
4
+
5
+ # Insiders
6
+
7
+ *Markdown Exec* 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][sponsorship], [how to become a sponsor][sponsors] to get access to Insiders, and [what's in it for you][features]!
8
+
9
+ ## What is Insiders?
10
+
11
+ *Markdown Exec Insiders* is a private fork of *Markdown Exec*, hosted as a private GitHub repository. Almost[^1] [all new features][features] are developed as part of this fork, which means that they are immediately available to all eligible sponsors, as they are granted access to this private repository.
12
+
13
+ [^1]: In general, every new feature is first exclusively released to sponsors, but sometimes upstream dependencies enhance existing features that must be supported by *Markdown Exec*.
14
+
15
+ Every feature is tied to a [funding goal][funding] in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into *Markdown Exec* and released for general availability, making them available to all users. Bugfixes are always released in tandem.
16
+
17
+ Sponsorships start as low as [**$10 a month**][sponsors].[^2]
18
+
19
+ [^2]: 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.
20
+
21
+ ## What sponsorships achieve
22
+
23
+ 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]
24
+
25
+ [^3]: 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 Exec*, you can be sure that bugs are fixed quickly and new features are added regularly.
26
+
27
+ If you're unsure if you should sponsor this project, check out the list of [completed funding goals][goals completed] 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][sponsors]!
28
+
29
+ ## What's in it for me?
30
+
31
+ ```python exec="1" session="insiders"
32
+ data_source = "docs/insiders/goals.yml"
33
+ ```
34
+
35
+ <!-- blacken-docs:off -->
36
+ ```python exec="1" session="insiders" idprefix=""
37
+ --8<-- "scripts/insiders.py"
38
+
39
+ if unreleased_features:
40
+ print(
41
+ "The moment you [become a sponsor](#how-to-become-a-sponsor), you'll get **immediate "
42
+ f"access to {len(unreleased_features)} additional features** that you can start using right away, and "
43
+ "which are currently exclusively available to sponsors:\n"
44
+ )
45
+
46
+ for feature in unreleased_features:
47
+ feature.render(badge=True)
48
+
49
+ print(
50
+ "\n\nThese are just the features related to this project. "
51
+ "[See the complete feature list on the author's main Insiders page](https://pawamoy.github.io/insiders/#whats-in-it-for-me)."
52
+ )
53
+ else:
54
+ print(
55
+ "The moment you [become a sponsor](#how-to-become-a-sponsor), you'll get immediate "
56
+ "access to all released features that you can start using right away, and "
57
+ "which are exclusively available to sponsors. At this moment, there are no "
58
+ "Insiders features for this project, but checkout the [next funding goals](#goals) "
59
+ "to see what's coming, as well as **[the feature list for all Insiders projects](https://pawamoy.github.io/insiders/#whats-in-it-for-me).**"
60
+ )
61
+ ```
62
+ <!-- blacken-docs:on -->
63
+
64
+ Additionally, your sponsorship will give more weight to your upvotes on issues, helping us prioritize work items in our backlog. For more information on how we prioritize work, see this page: [Backlog management][backlog].
65
+
66
+ ## How to become a sponsor
67
+
68
+ Thanks for your interest in sponsoring! In order to become an eligible sponsor with your GitHub account, visit [pawamoy's sponsor profile][github sponsor profile], and complete a sponsorship of **$10 a month or more**. You can use your individual or organization GitHub account for sponsoring.
69
+
70
+ Sponsorships lower than $10 a month are also very much appreciated, and useful. They won't grant you access to Insiders, but they will be counted towards reaching sponsorship goals. Every sponsorship helps us implementing new features and releasing them to the public.
71
+
72
+ **Important:** By default, when you're sponsoring **[@pawamoy][github sponsor profile]** through a GitHub organization, all the publicly visible members of the organization will be invited to join our private repositories. If you wish to only grant access to a subset of users, please send a short email to insiders@pawamoy.fr with the name of your organization and the GitHub accounts of the users that should be granted access.
73
+
74
+ **Tip:** to ensure that access is not tied to a particular individual GitHub account, you can 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 granted access to our private repositories, the bot account can create private forks of our private repositories into your own organization, which all members of your organization will have access to.
75
+
76
+ You can cancel your sponsorship anytime.[^5]
77
+
78
+ [^5]: 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.
79
+
80
+
81
+ [:octicons-heart-fill-24:{ .pulse } &nbsp; Join our <span id="sponsors-count"></span> awesome sponsors][github sponsor profile]{ .md-button .md-button--primary }
82
+
83
+ <hr>
84
+ <div class="premium-sponsors">
85
+ <div id="gold-sponsors"></div>
86
+ <div id="silver-sponsors"></div>
87
+ <div id="bronze-sponsors"></div>
88
+ </div>
89
+ <hr>
90
+
91
+ <div id="sponsors"></div>
92
+
93
+ <small>
94
+ If you sponsor publicly, you're automatically added here with a link to your profile and avatar to show your support for *Markdown Exec*. 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.
95
+ </small>
96
+
97
+ ## Funding <span class="sponsors-total"></span>
98
+
99
+ ### Goals
100
+
101
+ The following section lists all funding goals. Each goal contains a list of features prefixed with a checkmark symbol, denoting whether a feature is :octicons-check-circle-fill-24:{ style="color: #00e676" } already available or :octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
102
+
103
+ ```python exec="1" session="insiders" idprefix=""
104
+ for goal in goals.values():
105
+ if not goal.complete:
106
+ goal.render()
107
+ ```
108
+
109
+ ### Goals completed
110
+
111
+ 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.
112
+
113
+ ```python exec="1" session="insiders" idprefix=""
114
+ for goal in goals.values():
115
+ if goal.complete:
116
+ goal.render()
117
+ ```
118
+
119
+ ## Frequently asked questions
120
+
121
+ ### Compatibility
122
+
123
+ > We're building an open source project and want to allow outside collaborators to use *Markdown Exec* locally without having access to Insiders. Is this still possible?
124
+
125
+ Yes. Insiders is compatible with *Markdown Exec*. 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.
126
+
127
+ ### Payment
128
+
129
+ > We don't want to pay for sponsorship every month. Are there any other options?
130
+
131
+ Yes. You can sponsor on a yearly basis by [switching your GitHub account to a yearly billing cycle][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).
132
+
133
+ If you have any problems or further questions, please reach out to insiders@pawamoy.fr.
134
+
135
+ ### Terms
136
+
137
+ > Are we allowed to use Insiders under the same terms and conditions as *Markdown Exec*?
138
+
139
+ Yes. Whether you're an individual or a company, you may use *Markdown Exec Insiders* precisely under the same terms as *Markdown Exec*, which are given by the [ISC license][license]. However, we kindly ask you to respect our **fair use policy**:
140
+
141
+ - 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.
142
+ - If you cancel your subscription, your access to the private repository is revoked, and you 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][private forks].
143
+
144
+ [backlog]: https://pawamoy.github.io/backlog/
145
+ [insiders]: #what-is-insiders
146
+ [sponsorship]: #what-sponsorships-achieve
147
+ [sponsors]: #how-to-become-a-sponsor
148
+ [features]: #whats-in-it-for-me
149
+ [funding]: #funding
150
+ [goals completed]: #goals-completed
151
+ [github sponsor profile]: https://github.com/sponsors/pawamoy
152
+ [billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
153
+ [license]: ../license.md
154
+ [private forks]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
155
+
156
+ <script src="../js/insiders.js"></script>
157
+ <script>updateInsidersPage('pawamoy');</script>