markdown-exec 1.9.2__tar.gz → 1.10.0__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.
- markdown_exec-1.10.0/CHANGELOG.md +333 -0
- markdown_exec-1.10.0/CODE_OF_CONDUCT.md +133 -0
- markdown_exec-1.10.0/CONTRIBUTING.md +148 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/PKG-INFO +4 -7
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/README.md +0 -3
- markdown_exec-1.10.0/config/coverage.ini +25 -0
- markdown_exec-1.10.0/config/git-changelog.toml +9 -0
- markdown_exec-1.10.0/config/mypy.ini +9 -0
- markdown_exec-1.10.0/config/pytest.ini +14 -0
- markdown_exec-1.10.0/config/ruff.toml +84 -0
- markdown_exec-1.10.0/config/vscode/launch.json +47 -0
- markdown_exec-1.10.0/config/vscode/settings.json +33 -0
- markdown_exec-1.10.0/config/vscode/tasks.json +97 -0
- markdown_exec-1.10.0/docs/.overrides/main.html +20 -0
- markdown_exec-1.10.0/docs/.overrides/partials/comments.html +57 -0
- markdown_exec-1.10.0/docs/changelog.md +1 -0
- markdown_exec-1.10.0/docs/code_of_conduct.md +1 -0
- markdown_exec-1.10.0/docs/contributing.md +1 -0
- markdown_exec-1.10.0/docs/credits.md +10 -0
- markdown_exec-1.10.0/docs/css/insiders.css +124 -0
- markdown_exec-1.10.0/docs/css/material.css +4 -0
- markdown_exec-1.10.0/docs/css/mkdocstrings.css +27 -0
- markdown_exec-1.10.0/docs/gallery.md +231 -0
- markdown_exec-1.10.0/docs/index.md +6 -0
- markdown_exec-1.10.0/docs/insiders/changelog.md +12 -0
- markdown_exec-1.10.0/docs/insiders/goals.yml +16 -0
- markdown_exec-1.10.0/docs/insiders/index.md +239 -0
- markdown_exec-1.10.0/docs/insiders/installation.md +88 -0
- markdown_exec-1.10.0/docs/js/feedback.js +14 -0
- markdown_exec-1.10.0/docs/js/insiders.js +74 -0
- markdown_exec-1.10.0/docs/license.md +10 -0
- markdown_exec-1.10.0/docs/schema.json +32 -0
- markdown_exec-1.10.0/docs/snippets/gallery/ansi.sh +15 -0
- markdown_exec-1.10.0/docs/snippets/gallery/argparse.py +22 -0
- markdown_exec-1.10.0/docs/snippets/gallery/argparse_format.py +4 -0
- markdown_exec-1.10.0/docs/snippets/gallery/chalk.py +23 -0
- markdown_exec-1.10.0/docs/snippets/gallery/d2.py +48 -0
- markdown_exec-1.10.0/docs/snippets/gallery/diagrams.py +27 -0
- markdown_exec-1.10.0/docs/snippets/gallery/drawsvg.py +34 -0
- markdown_exec-1.10.0/docs/snippets/gallery/expandable_filetree.py +41 -0
- markdown_exec-1.10.0/docs/snippets/gallery/hyperbolic.py +61 -0
- markdown_exec-1.10.0/docs/snippets/gallery/matplotlib.py +32 -0
- markdown_exec-1.10.0/docs/snippets/gallery/plotly.py +4 -0
- markdown_exec-1.10.0/docs/snippets/gallery/pydeps.py +43 -0
- markdown_exec-1.10.0/docs/snippets/gallery/pytermgui.py +39 -0
- markdown_exec-1.10.0/docs/snippets/gallery/qrcode.py +5 -0
- markdown_exec-1.10.0/docs/snippets/gallery/rich.py +38 -0
- markdown_exec-1.10.0/docs/snippets/gallery/rich_terminal.py +31 -0
- markdown_exec-1.10.0/docs/snippets/gallery/runpy.py +18 -0
- markdown_exec-1.10.0/docs/snippets/gallery/textual.py +27 -0
- markdown_exec-1.10.0/docs/snippets/usage/boolean_matrix.py +7 -0
- markdown_exec-1.10.0/docs/snippets/usage/hide.py +2 -0
- markdown_exec-1.10.0/docs/snippets/usage/multiple.pycon +6 -0
- markdown_exec-1.10.0/docs/snippets/usage/platform_html.py +12 -0
- markdown_exec-1.10.0/docs/snippets/usage/platform_md.py +15 -0
- markdown_exec-1.10.0/docs/snippets/usage/source.py +1 -0
- markdown_exec-1.10.0/docs/snippets/usage/source.pycon +2 -0
- markdown_exec-1.10.0/docs/usage/index.md +487 -0
- markdown_exec-1.10.0/docs/usage/pyodide.md +170 -0
- markdown_exec-1.10.0/docs/usage/python.md +39 -0
- markdown_exec-1.10.0/docs/usage/shell.md +368 -0
- markdown_exec-1.10.0/docs/usage/tree.md +74 -0
- markdown_exec-1.10.0/duties.py +239 -0
- markdown_exec-1.10.0/mkdocs.yml +194 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/pyproject.toml +59 -3
- markdown_exec-1.10.0/scripts/gen_credits.py +179 -0
- markdown_exec-1.10.0/scripts/gen_ref_nav.py +37 -0
- markdown_exec-1.10.0/scripts/insiders.py +206 -0
- markdown_exec-1.10.0/scripts/make +1 -0
- markdown_exec-1.10.0/scripts/make.py +193 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/_exec_python.py +2 -2
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/base.py +3 -1
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/bash.py +2 -2
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/pyodide.py +3 -2
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/python.py +5 -2
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/sh.py +2 -2
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/mkdocs_plugin.py +3 -1
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/rendering.py +4 -3
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/conftest.py +1 -1
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/LICENSE +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/__init__.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/ansi.css +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/debug.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/__init__.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/console.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/markdown.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/pycon.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/formatters/tree.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/logger.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/processors.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/py.typed +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/pyodide.css +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/src/markdown_exec/pyodide.js +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/__init__.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/test_base_formatter.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/test_converter.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/test_headings.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/test_python.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/test_shell.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/test_toc.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/test_tree.py +0 -0
- {markdown_exec-1.9.2 → markdown_exec-1.10.0}/tests/test_validator.py +0 -0
@@ -0,0 +1,333 @@
|
|
1
|
+
# Changelog
|
2
|
+
All notable changes to this project will be documented in this file.
|
3
|
+
|
4
|
+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
5
|
+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
6
|
+
|
7
|
+
<!-- insertion marker -->
|
8
|
+
## [1.10.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.10.0) - 2024-12-06
|
9
|
+
|
10
|
+
<small>[Compare with 1.9.3](https://github.com/pawamoy/markdown-exec/compare/1.9.3...1.10.0)</small>
|
11
|
+
|
12
|
+
### Build
|
13
|
+
|
14
|
+
- Drop support for Python 3.8 ([103bc1d](https://github.com/pawamoy/markdown-exec/commit/103bc1dc5f07f330b9e7ca4f052714350c52389d) by Timothée Mazzucotelli).
|
15
|
+
|
16
|
+
### Features
|
17
|
+
|
18
|
+
- Allow setting Pyodide version ([912c8c7](https://github.com/pawamoy/markdown-exec/commit/912c8c75a5f579a949644f33bcead0b71e9637fd) by Andrew). [Issue-66](https://github.com/pawamoy/markdown-exec/issues/66), [PR-67](https://github.com/pawamoy/markdown-exec/pull/67), Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
|
19
|
+
|
20
|
+
## [1.9.3](https://github.com/pawamoy/markdown-exec/releases/tag/1.9.3) - 2024-06-24
|
21
|
+
|
22
|
+
<small>[Compare with 1.9.2](https://github.com/pawamoy/markdown-exec/compare/1.9.2...1.9.3)</small>
|
23
|
+
|
24
|
+
### Bug Fixes
|
25
|
+
|
26
|
+
- Fix patching lines in tracebacks on Python 3.13 ([917af4c](https://github.com/pawamoy/markdown-exec/commit/917af4c90138a861fb488b91b754231a04bf9f96) by Timothée Mazzucotelli). [Issue-58](https://github.com/pawamoy/markdown-exec/issues/58)
|
27
|
+
|
28
|
+
## [1.9.2](https://github.com/pawamoy/markdown-exec/releases/tag/1.9.2) - 2024-06-20
|
29
|
+
|
30
|
+
<small>[Compare with 1.9.1](https://github.com/pawamoy/markdown-exec/compare/1.9.1...1.9.2)</small>
|
31
|
+
|
32
|
+
### Bug Fixes
|
33
|
+
|
34
|
+
- Render source even if output is empty ([d3f1e6b](https://github.com/pawamoy/markdown-exec/commit/d3f1e6bcf245c656b0014e859e66137ad1e89549) by Timothée Mazzucotelli). [Issue-57](https://github.com/pawamoy/markdown-exec/issues/57)
|
35
|
+
|
36
|
+
## [1.9.1](https://github.com/pawamoy/markdown-exec/releases/tag/1.9.1) - 2024-06-14
|
37
|
+
|
38
|
+
<small>[Compare with 1.9.0](https://github.com/pawamoy/markdown-exec/compare/1.9.0...1.9.1)</small>
|
39
|
+
|
40
|
+
### Build
|
41
|
+
|
42
|
+
- Re-include tests folder in source distributions ([ae549db](https://github.com/pawamoy/markdown-exec/commit/ae549dbfb7382cf4fa8c35bdcfa4619231f37f4b) by Timothée Mazzucotelli). [Issue-55](https://github.com/pawamoy/markdown-exec/issues/55)
|
43
|
+
|
44
|
+
## [1.9.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.9.0) - 2024-06-13
|
45
|
+
|
46
|
+
<small>[Compare with 1.8.3](https://github.com/pawamoy/markdown-exec/compare/1.8.3...1.9.0)</small>
|
47
|
+
|
48
|
+
### Features
|
49
|
+
|
50
|
+
- Abort with error when the plugin is configured to require the ANSI extra but it is not installed ([25bcbbe](https://github.com/pawamoy/markdown-exec/commit/25bcbbe6cbc0e0df764456a508f03de2abfcd938) by Timothée Mazzucotelli).
|
51
|
+
- Allow excluding assets when rendering Pyodide fence ([5412353](https://github.com/pawamoy/markdown-exec/commit/541235354210522f67af8ff2dc03dfa5216bca20) by Timothée Mazzucotelli).
|
52
|
+
- Detect when SuperFences is not enabled and error out early ([5d771d2](https://github.com/pawamoy/markdown-exec/commit/5d771d285cecfcb631438f04b94f5b20275d03df) by Timothée Mazzucotelli). [Issue-39](https://github.com/pawamoy/markdown-exec/issues/39)
|
53
|
+
- Allow changing the console width for the execution of code blocks ([76d603c](https://github.com/pawamoy/markdown-exec/commit/76d603ce57232f2ee98f5abec265d2f67174fbdd) by Timothée Mazzucotelli). [Issue-34](https://github.com/pawamoy/markdown-exec/issues/34)
|
54
|
+
- Allow automatic execution of code blocks thanks to the `MARKDOWN_EXEC_AUTO` environment variable ([0db27b2](https://github.com/pawamoy/markdown-exec/commit/0db27b23dd7697afb19755b4ec32db43c4add75a) by Timothée Mazzucotelli). [Issue-24](https://github.com/pawamoy/markdown-exec/issues/24)
|
55
|
+
- Allow changing working directory for code blocks execution ([ee3fae9](https://github.com/pawamoy/markdown-exec/commit/ee3fae957193e2beb6ac9a0bad3b261d1b67584e) by Timothée Mazzucotelli). [Issue-20](https://github.com/pawamoy/markdown-exec/issues/20)
|
56
|
+
|
57
|
+
### Bug Fixes
|
58
|
+
|
59
|
+
- Reuse existing loggers tp prevent wrong dispatch ([8967270](https://github.com/pawamoy/markdown-exec/commit/8967270d821e5e021a2298ff8e458bc6ce0f1762) by Timothée Mazzucotelli).
|
60
|
+
- Don't render anything when code block output is empty ([4337d13](https://github.com/pawamoy/markdown-exec/commit/4337d1337b5aedd190627287f7e0a48000396902) by Timothée Mazzucotelli). [Issue-17](https://github.com/pawamoy/markdown-exec/issues/17)
|
61
|
+
- Increase minimum height of Pyodide output code blocks ([93598b2](https://github.com/pawamoy/markdown-exec/commit/93598b285babfca59b2b297adf804719f012f812) by Timothée Mazzucotelli). [Issue-40](https://github.com/pawamoy/markdown-exec/issues/40)
|
62
|
+
- Fix removal of temporary div for headings forwarding ([c012c1d](https://github.com/pawamoy/markdown-exec/commit/c012c1d9f194f492dcb055638c790580aa91c51e) by Timothée Mazzucotelli). [Issue-50](https://github.com/pawamoy/markdown-exec/issues/50)
|
63
|
+
|
64
|
+
### Code Refactoring
|
65
|
+
|
66
|
+
- Wrap placeholders in `<div>` to avoid them being wrapped in `<p>` ([500ed1b](https://github.com/pawamoy/markdown-exec/commit/500ed1b3a6bb94edd3d5d7152cd818bc3db27bbd) by Timothée Mazzucotelli).
|
67
|
+
|
68
|
+
## [1.8.3](https://github.com/pawamoy/markdown-exec/releases/tag/1.8.3) - 2024-05-22
|
69
|
+
|
70
|
+
<small>[Compare with 1.8.2](https://github.com/pawamoy/markdown-exec/compare/1.8.2...1.8.3)</small>
|
71
|
+
|
72
|
+
### Bug Fixes
|
73
|
+
|
74
|
+
- Don't leak future annotations in user code ([ba0c35e](https://github.com/pawamoy/markdown-exec/commit/ba0c35e89e3056325b3dcbc7e61b6f108ec55885) by Timothée Mazzucotelli). [Issue-47](https://github.com/pawamoy/markdown-exec/issues/47)
|
75
|
+
|
76
|
+
## [1.8.2](https://github.com/pawamoy/markdown-exec/releases/tag/1.8.2) - 2024-05-20
|
77
|
+
|
78
|
+
<small>[Compare with 1.8.1](https://github.com/pawamoy/markdown-exec/compare/1.8.1...1.8.2)</small>
|
79
|
+
|
80
|
+
### Bug Fixes
|
81
|
+
|
82
|
+
- Give `__name__` to executed Python "modules", and populate `sys.modules` too ([db25ee7](https://github.com/pawamoy/markdown-exec/commit/db25ee703da9b70cb4a13b2b4b61634d697119c4) by Timothée Mazzucotelli). [Issue-47](https://github.com/pawamoy/markdown-exec/issues/47)
|
83
|
+
|
84
|
+
## [1.8.1](https://github.com/pawamoy/markdown-exec/releases/tag/1.8.1) - 2024-04-15
|
85
|
+
|
86
|
+
<small>[Compare with 1.8.0](https://github.com/pawamoy/markdown-exec/compare/1.8.0...1.8.1)</small>
|
87
|
+
|
88
|
+
### Bug Fixes
|
89
|
+
|
90
|
+
- Add missing CSS classes to the ANSI stylesheet ([51493f2](https://github.com/pawamoy/markdown-exec/commit/51493f255dd91f28ce6c8d7e7176ec5687e28b4a) by Timothée Mazzucotelli). [Issue-43](https://github.com/pawamoy/markdown-exec/issues/43)
|
91
|
+
|
92
|
+
## [1.8.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.8.0) - 2024-01-05
|
93
|
+
|
94
|
+
<small>[Compare with 1.7.0](https://github.com/pawamoy/markdown-exec/compare/1.7.0...1.8.0)</small>
|
95
|
+
|
96
|
+
### Features
|
97
|
+
|
98
|
+
- Add `pyodide` fence ([3a2fab0](https://github.com/pawamoy/markdown-exec/commit/3a2fab0b23196a4122bcee6d9b81d3f421f11bbb) by Timothée Mazzucotelli).
|
99
|
+
- Add `ansi` option to mark ANSI extra as required or not ([27743c2](https://github.com/pawamoy/markdown-exec/commit/27743c20f56dd00ce730e1d028d362a4f95e48c7) by Timothée Mazzucotelli). [Issue #28](https://github.com/pawamoy/markdown-exec/issues/28), [Issue #29](https://github.com/pawamoy/markdown-exec/issues/29)
|
100
|
+
|
101
|
+
### Code Refactoring
|
102
|
+
|
103
|
+
- Modernize MkDocs plugin ([4864608](https://github.com/pawamoy/markdown-exec/commit/48646081746c6c5ece0c6566a4b9733ace518791) by Timothée Mazzucotelli).
|
104
|
+
|
105
|
+
## [1.7.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.7.0) - 2023-10-17
|
106
|
+
|
107
|
+
<small>[Compare with 1.6.0](https://github.com/pawamoy/markdown-exec/compare/1.6.0...1.7.0)</small>
|
108
|
+
|
109
|
+
### Features
|
110
|
+
|
111
|
+
- Set `MKDOCS_CONFIG_DIR` environment variable to build file path relative to it ([a2cbea5](https://github.com/pawamoy/markdown-exec/commit/a2cbea52d39ef43960c910830eae14dc846624d0) by Timothée Mazzucotelli).
|
112
|
+
|
113
|
+
## [1.6.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.6.0) - 2023-04-18
|
114
|
+
|
115
|
+
<small>[Compare with 1.5.3](https://github.com/pawamoy/markdown-exec/compare/1.5.3...1.6.0)</small>
|
116
|
+
|
117
|
+
### Features
|
118
|
+
|
119
|
+
- Add `idprefix` option allowing to change/remove HTML id/href prefixes ([4d91463](https://github.com/pawamoy/markdown-exec/commit/4d914630e5642feb87103644800d3c9f7b59c6ad) by Timothée Mazzucotelli).
|
120
|
+
|
121
|
+
## [1.5.3](https://github.com/pawamoy/markdown-exec/releases/tag/1.5.3) - 2023-04-18
|
122
|
+
|
123
|
+
<small>[Compare with 1.5.2](https://github.com/pawamoy/markdown-exec/compare/1.5.2...1.5.3)</small>
|
124
|
+
|
125
|
+
### Code Refactoring
|
126
|
+
|
127
|
+
- Reuse Markdown configuration as declared in mkdocs.yml ([afe091c](https://github.com/pawamoy/markdown-exec/commit/afe091caa33ed54fd65e25e4f90b8b60786ba3f9) by Timothée Mazzucotelli).
|
128
|
+
|
129
|
+
## [1.5.2](https://github.com/pawamoy/markdown-exec/releases/tag/1.5.2) - 2023-04-18
|
130
|
+
|
131
|
+
<small>[Compare with 1.5.1](https://github.com/pawamoy/markdown-exec/compare/1.5.1...1.5.2)</small>
|
132
|
+
|
133
|
+
### Code Refactoring
|
134
|
+
|
135
|
+
- Reset counter in post build event ([3bf80de](https://github.com/pawamoy/markdown-exec/commit/3bf80deabe9a7438b459c73e962c9693bce71135) by Timothée Mazzucotelli).
|
136
|
+
|
137
|
+
## [1.5.1](https://github.com/pawamoy/markdown-exec/releases/tag/1.5.1) - 2023-04-17
|
138
|
+
|
139
|
+
<small>[Compare with 1.5.0](https://github.com/pawamoy/markdown-exec/compare/1.5.0...1.5.1)</small>
|
140
|
+
|
141
|
+
### Bug Fixes
|
142
|
+
|
143
|
+
- Remove pycon output lines when rendering source as console ([fb5a23d](https://github.com/pawamoy/markdown-exec/commit/fb5a23d8d1d50aa2a1ede97150c269a07fa200ec) by Timothée Mazzucotelli).
|
144
|
+
- Fix nested rendering ([a110d44](https://github.com/pawamoy/markdown-exec/commit/a110d446209b390ec8a4ad8868818352f72a9808) by Timothée Mazzucotelli).
|
145
|
+
|
146
|
+
## [1.5.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.5.0) - 2023-04-17
|
147
|
+
|
148
|
+
<small>[Compare with 1.4.1](https://github.com/pawamoy/markdown-exec/compare/1.4.1...1.5.0)</small>
|
149
|
+
|
150
|
+
### Features
|
151
|
+
|
152
|
+
- Update ToC with generated headings ([5ea2263](https://github.com/pawamoy/markdown-exec/commit/5ea2263d53729b6d3e79da69c29b171bb6c3e22d) by Timothée Mazzucotelli).
|
153
|
+
|
154
|
+
## [1.4.1](https://github.com/pawamoy/markdown-exec/releases/tag/1.4.1) - 2023-04-16
|
155
|
+
|
156
|
+
<small>[Compare with 1.4.0](https://github.com/pawamoy/markdown-exec/compare/1.4.0...1.4.1)</small>
|
157
|
+
|
158
|
+
### Bug Fixes
|
159
|
+
|
160
|
+
- Improve handling of errors within sessions ([87ac5f3](https://github.com/pawamoy/markdown-exec/commit/87ac5f352ce44370f52a7fb56d846c04b76447f9) by Timothée Mazzucotelli).
|
161
|
+
- Swallow non-extra parameters in run functions ([f5d4fef](https://github.com/pawamoy/markdown-exec/commit/f5d4fef1f78d94c3f8850f873076e3cd68c0a981) by Timothée Mazzucotelli).
|
162
|
+
|
163
|
+
### Code Refactoring
|
164
|
+
|
165
|
+
- Simplify tree formatter signature ([09d5427](https://github.com/pawamoy/markdown-exec/commit/09d542772ccb0d1250366b39fa3a9c9362e1ed42) by Timothée Mazzucotelli).
|
166
|
+
|
167
|
+
## [1.4.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.4.0) - 2023-03-15
|
168
|
+
|
169
|
+
<small>[Compare with 1.3.0](https://github.com/pawamoy/markdown-exec/compare/1.3.0...1.4.0)</small>
|
170
|
+
|
171
|
+
### Features
|
172
|
+
|
173
|
+
- Sessions: persist and reuse state for Python and Pycon code blocks ([a8fef5e](https://github.com/pawamoy/markdown-exec/commit/a8fef5e90b1d7165e16ff5afe4b84e8441503098) by Timothée Mazzucotelli). [Issue #16](https://github.com/pawamoy/markdown-exec/issues/16)
|
174
|
+
|
175
|
+
## [1.3.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.3.0) - 2023-02-18
|
176
|
+
|
177
|
+
<small>[Compare with 1.2.0](https://github.com/pawamoy/markdown-exec/compare/1.2.0...1.3.0)</small>
|
178
|
+
|
179
|
+
### Features
|
180
|
+
|
181
|
+
- Support wrapping result with console source ([268c82e](https://github.com/pawamoy/markdown-exec/commit/268c82e6f005dcaa1ddc75608d2f28927f069761) by Timothée Mazzucotelli). [Issue #13](https://github.com/pawamoy/markdown-exec/issues/13)
|
182
|
+
|
183
|
+
### Code Refactoring
|
184
|
+
|
185
|
+
- Remove margin hack from Material source ([beec237](https://github.com/pawamoy/markdown-exec/commit/beec2374b27075e66ddb4a7cdc2f2c81b7455b95) by Timothée Mazzucotelli).
|
186
|
+
- Better support pycon syntax ([22b51c6](https://github.com/pawamoy/markdown-exec/commit/22b51c64155060922e46ea10e6c0d1c1c1b00a2f) by Timothée Mazzucotelli).
|
187
|
+
|
188
|
+
## [1.2.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.2.0) - 2023-02-01
|
189
|
+
|
190
|
+
<small>[Compare with 1.1.0](https://github.com/pawamoy/markdown-exec/compare/1.1.0...1.2.0)</small>
|
191
|
+
|
192
|
+
### Features
|
193
|
+
- Support ANSI code blocks ([39719c5](https://github.com/pawamoy/markdown-exec/commit/39719c5d7ac1bbde6d60002082a0ad3b48730545) by Timothée Mazzucotelli). [Issue #11](https://github.com/pawamoy/markdown-exec/issues/11)
|
194
|
+
|
195
|
+
|
196
|
+
## [1.1.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.1.0) - 2023-01-27
|
197
|
+
|
198
|
+
<small>[Compare with 1.0.0](https://github.com/pawamoy/markdown-exec/compare/1.0.0...1.1.0)</small>
|
199
|
+
|
200
|
+
### Features
|
201
|
+
- Log details to help debugging errors ([4c0228d](https://github.com/pawamoy/markdown-exec/commit/4c0228da41f5970e719b20a40c0fab47a9d12244) by Timothée Mazzucotelli). [Issue #12](https://github.com/pawamoy/markdown-exec/issues/12)
|
202
|
+
- Allow expecting specific exit codes ([620ec66](https://github.com/pawamoy/markdown-exec/commit/620ec66182dd0f84600258408720779822615085) by Timothée Mazzucotelli). [Issue #10](https://github.com/pawamoy/markdown-exec/issues/10)
|
203
|
+
|
204
|
+
### Code Refactoring
|
205
|
+
- Formatters now only accept keyword arguments ([0940ca9](https://github.com/pawamoy/markdown-exec/commit/0940ca98e81548474351e234715df2fc290fdc1e) by Timothée Mazzucotelli).
|
206
|
+
|
207
|
+
|
208
|
+
## [1.0.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.0.0) - 2022-11-24
|
209
|
+
|
210
|
+
<small>[Compare with 0.7.4](https://github.com/pawamoy/markdown-exec/compare/0.7.4...1.0.0)</small>
|
211
|
+
|
212
|
+
### Features
|
213
|
+
- Allow defining IDs on code blocks (for warnings) ([0091167](https://github.com/pawamoy/markdown-exec/commit/009116719e81dd91190b391c82709fb179a62364) by Timothée Mazzucotelli).
|
214
|
+
|
215
|
+
### Code Refactoring
|
216
|
+
- Use base format everywhere (more flexible) ([cefba70](https://github.com/pawamoy/markdown-exec/commit/cefba704ae45df1b115b969e3d4d5105ebd052dd) by Timothée Mazzucotelli).
|
217
|
+
|
218
|
+
|
219
|
+
## [0.7.4](https://github.com/pawamoy/markdown-exec/releases/tag/0.7.4) - 2022-11-13
|
220
|
+
|
221
|
+
<small>[Compare with 0.7.3](https://github.com/pawamoy/markdown-exec/compare/0.7.3...0.7.4)</small>
|
222
|
+
|
223
|
+
### Bug Fixes
|
224
|
+
- Render source for non-HTML output (regression) ([3028dcd](https://github.com/pawamoy/markdown-exec/commit/3028dcd4f20f94b578995c326fd68d53a6dc3638) by Timothée Mazzucotelli).
|
225
|
+
|
226
|
+
|
227
|
+
## [0.7.3](https://github.com/pawamoy/markdown-exec/releases/tag/0.7.3) - 2022-11-13
|
228
|
+
|
229
|
+
<small>[Compare with 0.7.2](https://github.com/pawamoy/markdown-exec/compare/0.7.2...0.7.3)</small>
|
230
|
+
|
231
|
+
### Bug Fixes
|
232
|
+
- Don't wrap HTML in `p` tag ([420d79d](https://github.com/pawamoy/markdown-exec/commit/420d79d67c2a6bdc925b3bc3d89790258f922317) by Timothée Mazzucotelli).
|
233
|
+
|
234
|
+
|
235
|
+
## [0.7.2](https://github.com/pawamoy/markdown-exec/releases/tag/0.7.2) - 2022-09-01
|
236
|
+
|
237
|
+
<small>[Compare with 0.7.1](https://github.com/pawamoy/markdown-exec/compare/0.7.1...0.7.2)</small>
|
238
|
+
|
239
|
+
### Bug Fixes
|
240
|
+
- Make `tree` formatter forward extra options ([54996a9](https://github.com/pawamoy/markdown-exec/commit/54996a9bc2c803bb8c9de0861af69723ddb000fa) by Timothée Mazzucotelli).
|
241
|
+
- Fix race condition issue ([37d7f86](https://github.com/pawamoy/markdown-exec/commit/37d7f86eeaa73029ae89c1c5d07146d2387b10d3) by Timothée Mazzucotelli).
|
242
|
+
|
243
|
+
|
244
|
+
## [0.7.1](https://github.com/pawamoy/markdown-exec/releases/tag/0.7.1) - 2022-08-28
|
245
|
+
|
246
|
+
<small>[Compare with 0.7.0](https://github.com/pawamoy/markdown-exec/compare/0.7.0...0.7.1)</small>
|
247
|
+
|
248
|
+
### Bug Fixes
|
249
|
+
- Allow printing non-string objects ([ceaa482](https://github.com/pawamoy/markdown-exec/commit/ceaa482d16adfbd1609595a2ed6a241bad71f9de) by Timothée Mazzucotelli). [Issue #7](https://github.com/pawamoy/markdown-exec/issues/7)
|
250
|
+
|
251
|
+
|
252
|
+
## [0.7.0](https://github.com/pawamoy/markdown-exec/releases/tag/0.7.0) - 2022-05-28
|
253
|
+
|
254
|
+
<small>[Compare with 0.6.0](https://github.com/pawamoy/markdown-exec/compare/0.6.0...0.7.0)</small>
|
255
|
+
|
256
|
+
### Features
|
257
|
+
- Add ability to hide source lines ([3cb1934](https://github.com/pawamoy/markdown-exec/commit/3cb19345fa2b65478ac439b5f486d04bf5ff5337) by Timothée Mazzucotelli).
|
258
|
+
|
259
|
+
|
260
|
+
## [0.6.0](https://github.com/pawamoy/markdown-exec/releases/tag/0.6.0) - 2022-05-21
|
261
|
+
|
262
|
+
<small>[Compare with 0.5.0](https://github.com/pawamoy/markdown-exec/compare/0.5.0...0.6.0)</small>
|
263
|
+
|
264
|
+
### Features
|
265
|
+
- Add tree formatter ([8096990](https://github.com/pawamoy/markdown-exec/commit/8096990dcbf6795572e5e5afee12195d5a56c6f6) by Timothée Mazzucotelli).
|
266
|
+
- Handle code blocks execution errors and log warnings ([34e16db](https://github.com/pawamoy/markdown-exec/commit/34e16db679721db7d1df375912d512b5aed80b1a) by Timothée Mazzucotelli).
|
267
|
+
|
268
|
+
### Bug Fixes
|
269
|
+
- Fix Python execution to support nested scopes ([74b9a95](https://github.com/pawamoy/markdown-exec/commit/74b9a95ade3862752fb78d6c64be8b9b1d4d3886) by Timothée Mazzucotelli).
|
270
|
+
|
271
|
+
|
272
|
+
## [0.5.0](https://github.com/pawamoy/markdown-exec/releases/tag/0.5.0) - 2022-05-09
|
273
|
+
|
274
|
+
<small>[Compare with 0.4.0](https://github.com/pawamoy/markdown-exec/compare/0.4.0...0.5.0)</small>
|
275
|
+
|
276
|
+
### Features
|
277
|
+
- Allow wrapping result in code block ([37201e4](https://github.com/pawamoy/markdown-exec/commit/37201e4409badec903f311bcc0a6ab7acddff37c) by Timothée Mazzucotelli).
|
278
|
+
- Add support for shell code blocks ([f2b4b67](https://github.com/pawamoy/markdown-exec/commit/f2b4b671f4399637d0dac235a0af7739033f9526) by Timothée Mazzucotelli).
|
279
|
+
|
280
|
+
### Code Refactoring
|
281
|
+
- Fetch plugin languages from dict ([de8309e](https://github.com/pawamoy/markdown-exec/commit/de8309e6895a079031461bfea317215bcff9bc21) by Timothée Mazzucotelli).
|
282
|
+
- Add reusable base formatter ([c265bee](https://github.com/pawamoy/markdown-exec/commit/c265bee9abf0ad545b7fdc6ccf2e320071295a18) by Timothée Mazzucotelli).
|
283
|
+
|
284
|
+
|
285
|
+
## [0.4.0](https://github.com/pawamoy/markdown-exec/releases/tag/0.4.0) - 2022-05-09
|
286
|
+
|
287
|
+
<small>[Compare with 0.3.1](https://github.com/pawamoy/markdown-exec/compare/0.3.1...0.4.0)</small>
|
288
|
+
|
289
|
+
### Features
|
290
|
+
- Add literate Markdown support ([8d3ed7e](https://github.com/pawamoy/markdown-exec/commit/8d3ed7ef5c9a88849be0a5da44e7b478eb44c180) by Timothée Mazzucotelli).
|
291
|
+
- Add `material-block` style to show source ([ff10ee1](https://github.com/pawamoy/markdown-exec/commit/ff10ee1f0b55b2e77b97f272b49b24024f9de2ac) by Timothée Mazzucotelli).
|
292
|
+
- Support up to 8 levels of exec code block nesting ([bfde808](https://github.com/pawamoy/markdown-exec/commit/bfde8087ca6f4eb91aba8eb01b37755dfacb4cdb) by Timothée Mazzucotelli).
|
293
|
+
|
294
|
+
|
295
|
+
## [0.3.1](https://github.com/pawamoy/markdown-exec/releases/tag/0.3.1) - 2022-05-07
|
296
|
+
|
297
|
+
<small>[Compare with 0.3.0](https://github.com/pawamoy/markdown-exec/compare/0.3.0...0.3.1)</small>
|
298
|
+
|
299
|
+
### Bug Fixes
|
300
|
+
- Actually prevent HTML re-rendering ([4374852](https://github.com/pawamoy/markdown-exec/commit/4374852706207beac3b8dbd8dc9d75be51b1df0d) by Timothée Mazzucotelli).
|
301
|
+
|
302
|
+
|
303
|
+
## [0.3.0](https://github.com/pawamoy/markdown-exec/releases/tag/0.3.0) - 2022-05-01
|
304
|
+
|
305
|
+
<small>[Compare with 0.2.0](https://github.com/pawamoy/markdown-exec/compare/0.2.0...0.3.0)</small>
|
306
|
+
|
307
|
+
### Features
|
308
|
+
- Support `pycon` code blocks ([2c86394](https://github.com/pawamoy/markdown-exec/commit/2c86394417858654af21316c3555aff0e9fd2d26) by Timothée Mazzucotelli).
|
309
|
+
- Add `console` source integration option ([62dfd74](https://github.com/pawamoy/markdown-exec/commit/62dfd74185f7f33cdf6f4726b3aa898a1ac5d22f) by Timothée Mazzucotelli).
|
310
|
+
- Provide a MkDocs plugin for easier setup ([5fce814](https://github.com/pawamoy/markdown-exec/commit/5fce81462063b7c61d9833939e44958a466d4b24) by Timothée Mazzucotelli).
|
311
|
+
- Support changing tabs titles ([d150596](https://github.com/pawamoy/markdown-exec/commit/d150596beda1e5a5304bc06e27668294a75ff220) by Timothée Mazzucotelli).
|
312
|
+
- Allow using `print` in code blocks ([7c124fd](https://github.com/pawamoy/markdown-exec/commit/7c124fd416d6923bea2834479d972b14c3e22112) by Timothée Mazzucotelli).
|
313
|
+
- Allow passing extra opts like title to source code blocks ([bb3252a](https://github.com/pawamoy/markdown-exec/commit/bb3252a3e959cea198966ba59a70f6f5aa57a963) by Timothée Mazzucotelli).
|
314
|
+
|
315
|
+
### Code Refactoring
|
316
|
+
- Split Python formatter to allow reuse ([fc56702](https://github.com/pawamoy/markdown-exec/commit/fc56702b9c393323adc30abba42c823f601ef738) by Timothée Mazzucotelli).
|
317
|
+
- Setup a more robust Markdown converter ([395f4c4](https://github.com/pawamoy/markdown-exec/commit/395f4c4c21ab7f4afcc88250c1fd882269a06d02) by Timothée Mazzucotelli).
|
318
|
+
|
319
|
+
|
320
|
+
## [0.2.0](https://github.com/pawamoy/markdown-exec/releases/tag/0.2.0) - 2022-04-18
|
321
|
+
|
322
|
+
<small>[Compare with 0.1.0](https://github.com/pawamoy/markdown-exec/compare/0.1.0...0.2.0)</small>
|
323
|
+
|
324
|
+
### Features
|
325
|
+
- Add ability to render using tabs ([91a95ae](https://github.com/pawamoy/markdown-exec/commit/91a95ae4c6ad82e85dac24a110d09ca71eff688a) by Timothée Mazzucotelli).
|
326
|
+
|
327
|
+
|
328
|
+
## [0.1.0](https://github.com/pawamoy/markdown-exec/releases/tag/0.1.0) - 2022-02-19
|
329
|
+
|
330
|
+
<small>[Compare with first commit](https://github.com/pawamoy/markdown-exec/compare/41c8d81992d2443cd5c3418df0f461b0af1a6ec8...0.1.0)</small>
|
331
|
+
|
332
|
+
### Features
|
333
|
+
- Implement execution of code blocks ([41c8d81](https://github.com/pawamoy/markdown-exec/commit/41c8d81992d2443cd5c3418df0f461b0af1a6ec8) by Timothée Mazzucotelli).
|
@@ -0,0 +1,133 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
10
|
+
identity and orientation.
|
11
|
+
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
13
|
+
diverse, inclusive, and healthy community.
|
14
|
+
|
15
|
+
## Our Standards
|
16
|
+
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
18
|
+
community include:
|
19
|
+
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
24
|
+
and learning from the experience
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
26
|
+
community
|
27
|
+
|
28
|
+
Examples of unacceptable behavior include:
|
29
|
+
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
31
|
+
any kind
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
33
|
+
* Public or private harassment
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
35
|
+
without their explicit permission
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
37
|
+
professional setting
|
38
|
+
|
39
|
+
## Enforcement Responsibilities
|
40
|
+
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
44
|
+
or harmful.
|
45
|
+
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
49
|
+
decisions when appropriate.
|
50
|
+
|
51
|
+
## Scope
|
52
|
+
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
54
|
+
an individual is officially representing the community in public spaces.
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
56
|
+
posting via an official social media account, or acting as an appointed
|
57
|
+
representative at an online or offline event.
|
58
|
+
|
59
|
+
## Enforcement
|
60
|
+
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
62
|
+
reported to the community leaders responsible for enforcement at
|
63
|
+
dev@pawamoy.fr.
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
65
|
+
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
67
|
+
reporter of any incident.
|
68
|
+
|
69
|
+
## Enforcement Guidelines
|
70
|
+
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
73
|
+
|
74
|
+
### 1. Correction
|
75
|
+
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
77
|
+
unprofessional or unwelcome in the community.
|
78
|
+
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
82
|
+
|
83
|
+
### 2. Warning
|
84
|
+
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
86
|
+
actions.
|
87
|
+
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
93
|
+
ban.
|
94
|
+
|
95
|
+
### 3. Temporary Ban
|
96
|
+
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
98
|
+
sustained inappropriate behavior.
|
99
|
+
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
101
|
+
communication with the community for a specified period of time. No public or
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
104
|
+
Violating these terms may lead to a permanent ban.
|
105
|
+
|
106
|
+
### 4. Permanent Ban
|
107
|
+
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
111
|
+
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
113
|
+
community.
|
114
|
+
|
115
|
+
## Attribution
|
116
|
+
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
118
|
+
version 2.1, available at
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
120
|
+
|
121
|
+
Community Impact Guidelines were inspired by
|
122
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
123
|
+
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
127
|
+
|
128
|
+
[homepage]: https://www.contributor-covenant.org
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
130
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
131
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
132
|
+
[translations]: https://www.contributor-covenant.org/translations
|
133
|
+
|
@@ -0,0 +1,148 @@
|
|
1
|
+
# Contributing
|
2
|
+
|
3
|
+
Contributions are welcome, and they are greatly appreciated!
|
4
|
+
Every little bit helps, and credit will always be given.
|
5
|
+
|
6
|
+
## Environment setup
|
7
|
+
|
8
|
+
Nothing easier!
|
9
|
+
|
10
|
+
Fork and clone the repository, then:
|
11
|
+
|
12
|
+
```bash
|
13
|
+
cd markdown-exec
|
14
|
+
make setup
|
15
|
+
```
|
16
|
+
|
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.
|
22
|
+
>
|
23
|
+
> You can install it with:
|
24
|
+
>
|
25
|
+
> ```bash
|
26
|
+
> curl -LsSf https://astral.sh/uv/install.sh | sh
|
27
|
+
> ```
|
28
|
+
>
|
29
|
+
> Now you can try running `make setup` again,
|
30
|
+
> or simply `uv sync`.
|
31
|
+
|
32
|
+
You now have the dependencies installed.
|
33
|
+
|
34
|
+
Run `make help` to see all the available actions!
|
35
|
+
|
36
|
+
## Tasks
|
37
|
+
|
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).
|
43
|
+
|
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.
|
47
|
+
|
48
|
+
## Development
|
49
|
+
|
50
|
+
As usual:
|
51
|
+
|
52
|
+
1. create a new branch: `git switch -c feature-or-bugfix-name`
|
53
|
+
1. edit the code and/or the documentation
|
54
|
+
|
55
|
+
**Before committing:**
|
56
|
+
|
57
|
+
1. run `make format` to auto-format the code
|
58
|
+
1. run `make check` to check everything (fix any warning)
|
59
|
+
1. run `make test` to run the tests (fix any issue)
|
60
|
+
1. if you updated the documentation or the project dependencies:
|
61
|
+
1. run `make docs`
|
62
|
+
1. go to http://localhost:8000 and check that everything looks good
|
63
|
+
1. follow our [commit message convention](#commit-message-convention)
|
64
|
+
|
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.
|
68
|
+
|
69
|
+
Don't bother updating the changelog, we will take care of this.
|
70
|
+
|
71
|
+
## Commit message convention
|
72
|
+
|
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):
|
76
|
+
|
77
|
+
```
|
78
|
+
<type>[(scope)]: Subject
|
79
|
+
|
80
|
+
[Body]
|
81
|
+
```
|
82
|
+
|
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.
|
87
|
+
|
88
|
+
Scope and body are optional. Type can be:
|
89
|
+
|
90
|
+
- `build`: About packaging, building wheels, etc.
|
91
|
+
- `chore`: About packaging or repo/files management.
|
92
|
+
- `ci`: About Continuous Integration.
|
93
|
+
- `deps`: Dependencies update.
|
94
|
+
- `docs`: About documentation.
|
95
|
+
- `feat`: New feature.
|
96
|
+
- `fix`: Bug fix.
|
97
|
+
- `perf`: About performance.
|
98
|
+
- `refactor`: Changes that are not features or bug fixes.
|
99
|
+
- `style`: A change in code style/format.
|
100
|
+
- `tests`: About tests.
|
101
|
+
|
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:
|
105
|
+
|
106
|
+
```
|
107
|
+
Body.
|
108
|
+
|
109
|
+
Issue #10: https://github.com/namespace/project/issues/10
|
110
|
+
Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
|
111
|
+
```
|
112
|
+
|
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).
|
119
|
+
|
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.
|
123
|
+
|
124
|
+
## Pull requests guidelines
|
125
|
+
|
126
|
+
Link to any related issue in the Pull Request message.
|
127
|
+
|
128
|
+
During the review, we recommend using fixups:
|
129
|
+
|
130
|
+
```bash
|
131
|
+
# SHA is the SHA of the commit you want to fix
|
132
|
+
git commit --fixup=SHA
|
133
|
+
```
|
134
|
+
|
135
|
+
Once all the changes are approved, you can squash your commits:
|
136
|
+
|
137
|
+
```bash
|
138
|
+
git rebase -i --autosquash main
|
139
|
+
```
|
140
|
+
|
141
|
+
And force-push:
|
142
|
+
|
143
|
+
```bash
|
144
|
+
git push -f
|
145
|
+
```
|
146
|
+
|
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.
|
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.1
|
2
2
|
Name: markdown-exec
|
3
|
-
Version: 1.
|
3
|
+
Version: 1.10.0
|
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>
|
@@ -10,12 +10,12 @@ Classifier: Intended Audience :: Developers
|
|
10
10
|
Classifier: Programming Language :: Python
|
11
11
|
Classifier: Programming Language :: Python :: 3
|
12
12
|
Classifier: Programming Language :: Python :: 3 :: Only
|
13
|
-
Classifier: Programming Language :: Python :: 3.8
|
14
13
|
Classifier: Programming Language :: Python :: 3.9
|
15
14
|
Classifier: Programming Language :: Python :: 3.10
|
16
15
|
Classifier: Programming Language :: Python :: 3.11
|
17
16
|
Classifier: Programming Language :: Python :: 3.12
|
18
17
|
Classifier: Programming Language :: Python :: 3.13
|
18
|
+
Classifier: Programming Language :: Python :: 3.14
|
19
19
|
Classifier: Topic :: Documentation
|
20
20
|
Classifier: Topic :: Software Development
|
21
21
|
Classifier: Topic :: Utilities
|
@@ -28,10 +28,10 @@ Project-URL: Issues, https://github.com/pawamoy/markdown-exec/issues
|
|
28
28
|
Project-URL: Discussions, https://github.com/pawamoy/markdown-exec/discussions
|
29
29
|
Project-URL: Gitter, https://gitter.im/markdown-exec/community
|
30
30
|
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
31
|
-
Requires-Python: >=3.
|
31
|
+
Requires-Python: >=3.9
|
32
32
|
Requires-Dist: pymdown-extensions>=9
|
33
|
-
Requires-Dist: pygments-ansi-color; extra == "ansi"
|
34
33
|
Provides-Extra: ansi
|
34
|
+
Requires-Dist: pygments-ansi-color; extra == "ansi"
|
35
35
|
Description-Content-Type: text/markdown
|
36
36
|
|
37
37
|
# Markdown Exec
|
@@ -39,7 +39,6 @@ Description-Content-Type: text/markdown
|
|
39
39
|
[](https://github.com/pawamoy/markdown-exec/actions?query=workflow%3Aci)
|
40
40
|
[](https://pawamoy.github.io/markdown-exec/)
|
41
41
|
[](https://pypi.org/project/markdown-exec/)
|
42
|
-
[](https://gitpod.io/#https://github.com/pawamoy/markdown-exec)
|
43
42
|
[](https://app.gitter.im/#/room/#markdown-exec:gitter.im)
|
44
43
|
|
45
44
|
Utilities to execute code blocks in Markdown files.
|
@@ -49,8 +48,6 @@ and this HTML is injected in place of the code block.
|
|
49
48
|
|
50
49
|
## Installation
|
51
50
|
|
52
|
-
With `pip`:
|
53
|
-
|
54
51
|
```bash
|
55
52
|
pip install markdown-exec[ansi]
|
56
53
|
```
|