Generate READMEs with collapsable* code and corresponding output from Python
Project description
autoreadme
Generate READMEs with collapsable* code and corresponding output from Python.
Installation
from package
# Set up a virtualenv.
python3 -m venv venv
source venv/bin/activate
# Install from PyPI
pip install autoreadme
from source
git clone https://github.com/davips/autoreadme
cd autoreadme
Example
A typical README-edit.md file would be:
# Uses
We can cook using the following Python code:
<<cook>>
However, we can also clean:
<<clean>>
The example file (given in this repo as examples/README-edit.md) depends on two scripts. Each script should have
a # ...
line where the output until that moment is expected to appear:
examples/cook.py:
# Cooking
x = 2 * 8
print("This script prints something:", x)
# ...
examples/clean.py:
# Cleaning
y = 34 % 5
print("this script prints another thing.", y)
# ...
Running...
autoreadme -i examples/README-edit.md -s examples/ -o examples/README.md examples/README-edit.md
...will result in the following markdown:
# UsesWe can cook using the following Python code:
Cooking
x = 2 * 8 print("This script prints something:", x)This script prints something: 16
However, we can also clean:
Cleaning
y = 34 % 5 print("this script prints another thing.", y)this script prints another thing. 4
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
autoreadme-0.2302.3.tar.gz
(16.5 kB
view hashes)
Built Distribution
Close
Hashes for autoreadme-0.2302.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ceb05156f486aaea9b2aa3ae2411f8a0e409027553b0aa9b33c5242596aa93d5 |
|
MD5 | 7b439f67ac16eafc10842abb1dcd4841 |
|
BLAKE2b-256 | f541e6501ae6ecbcbd17554953d5bdffa80316bc063c5e933e62842c246f136f |