Pull argparse configuration out of a CLI tool and write it as Markdown.
Great for embedded in a README.md with cog.
Usage
Possible invocation options:
# entrypoint command, dotted module
uv tool run argparse-help-markdown -m tests.data.example
# script, script
argparse_help_markdown.py --write.md script.py
# import, function
from argparse_help_markdown import run_script
run_script("mytool.py", include_usage=True)
What it does
It writes this table about itself:
usage: argparse_help_markdown.py script.py
| Options | Values | Help |
|---|---|---|
| positional arguments | ||
filename |
Optional. | Path to the subject script. |
| options | ||
-h --help |
Flag. | show this help message and exit |
--usage |
Flag. | Emit the terse usage info in triple-ticks. Excluded by default. |
--write |
Optional. | Write to named file instead of stdout. |
-m --module |
Optional. | Run as module. |
Installation, or not
This is built as a single-file that can be installed as a package or used standalone. It can be imported as a module or run on the command-line. It's mostly useful inside a documentation CICD pipeline, where flexability is key. No dependencies outside of standard library.
With uv: uv tool run argparse-help-markdown
With pipx: pipx run argparse-help-markdown
Or install with pip: pip install argparse-help-markdown
Or grab a locked version with curl: curl -O https://raw.githubusercontent.com/ellieayla/argparse-help-markdown/a35c9ea9cd975575adb45a4cbbf3d140adf04269/src/argparse_help_markdown.py; python3 argparse_help_markdown.py
1 maintainer
Metadata
1 maintainer
Release files for argparse-help-markdown 1.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| argparse_help_markdown-1.1.7-py3-none-any.whl | Python 3 | none | any | Details |
Release files / argparse_help_markdown-1.1.7-py3-none-any.whl
| Download URL | argparse_help_markdown-1.1.7-py3-none-any.whl |
|---|---|
| Size | 8.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
814d7e0bd08747b519e0cb835b435319cdbd6db09235e7bed2e8e3283f484472
|
|
BLAKE2b-256 checksum How to use checksums |
c0b28b4db2ee754e3d559884e96b8d97815702313eaa20dec66556f7b2f8add0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 3, 2026.
Transparency log
