exdown 0.9.0

Extract code blocks from markdown

exdown is deprecated. Use pytest-codeblocks instead.

---

exdown

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

Install with

pip install exdown

and create tests for pytest with

import exdown

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

The test_readme variable is really a decorated function that pytest will pick up and turn into tests.

tests/test_readme.py .............                    [100%]

Skipping code blocks

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

exdown.pytests_from_file("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.

Merging code blocks

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
```

Expected output

You can also define the expected output of a code block:

This
```
print(1 + 3)
```
gives
<!--exdown-expected-output-->
```
5
```

Expected errors

Some code blocks are expected to give errors. You can verify this with

The following gives an error:
<!--exdown-expect-exception-->
```python
1 / 0
```

License

This software is published under the MIT license.