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.
:: code-block:: shell
cd your-project vim README_template.rst poetry add –group dev readme-patcher poetry shell readme-patcher # README.rst
Global objects
py_project
{{ py_project.repository }}
github
{{ github.name }}
{{ github.full_name }}
{{ github.description }}
Functions
cli: Combined output (stdout and stderr) of command line interfaces (scripts / binaries)
{{ cli('awk --help') }}
func: return values of Python functions
{{ func('os.getcwd') }}
Filters
code
{{ func('os.getcwd') | code }}
literal
{{ 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.2.0.tar.gz
(5.3 kB
view hashes)
Built Distribution
Close
Hashes for readme_patcher-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25ada80c647ae55873b010343a6a1969c3dd29ef67ae06209fadb5db6574694c |
|
MD5 | 8e30a0d3d356c0ed05ac16601750607e |
|
BLAKE2b-256 | c0fd87c93138f65c5587b499d927d66e5f965056d00bc376ef431b35024725d6 |