Generate README files from templates. Allow input from functions calls and cli output.
Project description
readme_patcher
Generate README files from templates. Allow input from functions calls and cli output.
Functions
cli: Combined output (stdout and stderr) of command line interfaces (scripts / binaries)
{{ cli('awk --help') | code }}
func: return values of Python functions
{{ func('os.getcwd') | code }}
Filters
code
{{ func('os.getcwd') | code }}
Configuration
[[tool.readme_patcher.file]]
src = "README_template.rst"
dest = "README.rst"
variables = { cwd = "func:os.getcwd", fortune = "cli:fortune --help" }
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
readme_patcher-0.1.0.tar.gz
(4.3 kB
view hashes)
Built Distribution
Close
Hashes for readme_patcher-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c991a71c1665093fc053d53fbfc5be52632a30e3c9cedbb8895ab9d6462916bd |
|
MD5 | 713596cc77f43982ef373603cc961f60 |
|
BLAKE2b-256 | 5ee73026d64a6d0a26d833301ff1c0574860b6823cd3a9d48e1e3e35379c8994 |