Skip to main content

Extract code blocks from markdown

Project description

exdown

Extract code blocks from Markdown.

gh-actions codecov Code style: black PyPI pyversions PyPi Version GitHub stars PyPi downloads

This is exdown, a tool for extracting code blocks from Markdown files. This can be used for testing code in your README files.

Install with

pip install exdown

and use as

import exdown
import pytest

@pytest.mark.parametrize("string", exdown.extract("README.md"))
def test_readme(string):
    exec(string)

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

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

Testing

To run the unit tests, check out this repository and type

pytest

License

exdown is published under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exdown-0.6.0.zip (8.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page