A command line tool which allows you to run the code in your markdown files to ensure that readers always have access to working code.
Project description
DocRunner
A command line tool which allows you to run the code in your markdown files to ensure that readers always have access to working code.
What does it do?
Docrunner goes through your markdown file and runs any code in it, providing you safe testing for any markdown documentation. You can specify the path to the markdown file, along with other options, with flags.
Installation
Use the package manager pip to install docrunner.
pip install docrunner
QuickStart
py -m docrunner --help
or
docrunner
Python Example
docrunner python --markdown-path ./README.md --multi-file
This command executes all python within your README markdown file and does so by putting each snippet of python from your README into a separate file, and running each file. If you don't want each snippet in a separate python file, just remove the --multi-file option.
Supported Languages
- Python
- Javascript
- Typescript
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for docrunner-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a06d4c0f8c665ea8574e66949d07abc2f8779783d62f461fa7aac1bebb395d6c |
|
MD5 | d3d7c40fff7a892d34a6ba8ceabe12e7 |
|
BLAKE2b-256 | 7a0019e8bf9eee56d436e0caae22d5896f383fdc0f8bb589df857b37b970655c |