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: 16However, we can also clean:
Cleaning
y = 34 % 5 print("this script prints another thing.", y)this script prints another thing. 4
1 maintainer
Metadata
1 maintainer
Release files for autoreadme 0.2302.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| autoreadme-0.2302.3.tar.gz | 16.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autoreadme-0.2302.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 34.2 kB
Release files / autoreadme-0.2302.3.tar.gz
| Download URL | autoreadme-0.2302.3.tar.gz |
|---|---|
| Size | 16.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
936b1582a5c36d5972b30de8dc3c60bd2ca14ba1817940b892654aeba5b1c903
|
|
BLAKE2b-256 checksum How to use checksums |
c6fe0fe3bf22f63b172b880ec925a2fb6181f367f1efd6e5b5229ce67399a6bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.1
|
Release files / autoreadme-0.2302.3-py3-none-any.whl
| Download URL | autoreadme-0.2302.3-py3-none-any.whl |
|---|---|
| Size | 17.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ceb05156f486aaea9b2aa3ae2411f8a0e409027553b0aa9b33c5242596aa93d5
|
|
BLAKE2b-256 checksum How to use checksums |
f541e6501ae6ecbcbd17554953d5bdffa80316bc063c5e933e62842c246f136f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.1
|
