exdown 0.8.9

Extract code blocks from markdown

Extract and test code blocks from Markdown.

This is exdown, a tool for extracting code blocks from Markdown files and to create tests from them.

Install with

pip install exdown

and use as

import exdown

blocks = exdown.extract("README.md")

or, to create tests for pytest

import exdown

test_readme = exdown.pytests("README.md")

If you don't want all code blocks to be extracted, you can filter by syntax

exdown.pytests("README.md", syntax_filter="python")

or prefix your code block in the Markdown file with an exdown-skip comment

Lorem ipsum
<!--exdown-skip-->
```python
foo + bar  # not working
```
dolor sit amet.

All functions accept the encoding argument, too.

Broken-up code blocks can be merged into one with the exdown-cont prefix

Lorem ipsum
```
a = 1
```
dolor sit amet
<!--exdown-cont-->
```
# this would otherwise fail since `a` is not defined
a + 1
```

License

exdown is published under the MIT license.