readme-update 🦀
Tired of updating documentation?
This tool updates your README.md with a one line description for each of the python scripts in a directory you point it to (and recursively). It adds the text for lines that start with "Description: " and "Link: ". It ignores any that don't have the description.
You can supply alternative --table-fields to create a table with columns for the provided fields. The --link-fields argument is used to signal which of the --table-fields should be rendered as links like this [Link](this/is/the/link).
The idea is that links should link to higher level documentation (if it exists).
This can be used as a pre-commit for python projects with standalone scripts for specific processes.
It will update in place if the # Scripts block exists or else it will append it to the end of the README.md
example_usage.py shows how to call the script from python.
Here is an example output from the tool:
Scripts
| Name | Description | Link |
|---|---|---|
example1.py |
This is an example file that links to my own github. | Link |
example2.py |
Some other description. | |
example3.py |
Link | |
| :: |
Installation
pip install readme-update
Or
uv add readme-update
Usage
Assuming its is run from this location.
root/
scripts/
example_script.py
README.md
uv run -m update_readme \
--scripts-root "./scripts" \
--readme-path "./README.md"
Args
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
--scripts-root |
str |
✅ | Path to the root of the scripts to scan | |
--readme-path |
str |
❌ | './README.md' |
Path to the README file that will be modified |
--table-fields |
list |
❌ | ["Description", "Link"] |
Fields to dynamically add to the README.md table. |
--link-fields |
list |
❌ | ["Link"] |
Which of the provided table fields should be rendered as links. |
Ret codes
| RetCode | int | description |
|---|---|---|
NoModification |
0 | The Repo Map reflects the current state of the repo. |
ModifiedReadme |
1 | The README was updated. |
NoPyFiles |
2 | No python files found at the scripts-root location. |
FailedParsingFile |
3 | Failed to read README file |
FailedToWriteReadme |
4 | The given README.md path does not match the expected basename. |
InvalidLinkFields |
5 | The given link_fields are not a subset of the given table_fields. |
Repo map
├── .github
│ └── workflows
│ ├── ci.yaml
│ └── publish.yaml
├── python
│ └── update_readme
│ ├── __init__.py
│ └── __main__.py
├── scripts
│ ├── example1.py
│ ├── example2.py
│ └── example3.py
├── src
│ ├── core
│ │ ├── adapters.rs
│ │ ├── domain.rs
│ │ └── mod.rs
│ ├── api.rs
│ └── lib.rs
├── tests
│ └── integration_tests.rs
├── .pre-commit-config.yaml
├── Cargo.lock
├── Cargo.toml
├── README.md
├── pyproject.toml
└── uv.lock
::
1 maintainer
Release files for readme-update 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| readme_update-0.3.0.tar.gz | 22.3 kB | Details |
Built distributions (wheels)
Total release size: 10.4 MB
Release files / readme_update-0.3.0.tar.gz
| Download URL | readme_update-0.3.0.tar.gz |
|---|---|
| Size | 22.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
77f30111fcc4b905638bdcb99b7a76d48eb0bdede23fad3b2b9aeea590b785a0
|
|
BLAKE2b-256 checksum How to use checksums |
dd43a6a2983f384a8460e6d847bb53cdc90d05b13e90d7d07af4fa2fab6c5c55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp313-cp313-win_amd64.whl
| Download URL | readme_update-0.3.0-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 832.6 kB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
b51c1a5362582afb3a9ca596554ad3068275ef41f490ed33ece15e4a708e20e8
|
|
BLAKE2b-256 checksum How to use checksums |
d884c434b179050e2ff6c7d91fd4d27ce207729e057637947f309cb399aa92d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp313-cp313-manylinux_2_34_x86_64.whl
| Download URL | readme_update-0.3.0-cp313-cp313-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 944.9 kB |
| Tags | CPython 3.13 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
227aa9fa1f3f4aaff5cdc5b63d94593fb76815dd13cdf6c31f20a2bff7b23c70
|
|
BLAKE2b-256 checksum How to use checksums |
d40038f758fad32ae12d58b9a13ba6d40dbd9767fa099a5338c11a01f0453a9a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | readme_update-0.3.0-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 808.8 kB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
58775d1e2576b895b2ca6007a6840cfd06d96cb29daa4a72f4700c15d103f006
|
|
BLAKE2b-256 checksum How to use checksums |
1429bf577919eefb3304afea3f40cabefab9f41ab009b10187125346ce0b4000
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp312-cp312-win_amd64.whl
| Download URL | readme_update-0.3.0-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 832.6 kB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
fff65a6deb742973dbde7f1cd8ab17815f4027207a285ed9f2118add8dd13c7e
|
|
BLAKE2b-256 checksum How to use checksums |
25986dcee1bdfb64098f506c96581b2cc4b8a8553fd4d6b5411b867889cb940c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp312-cp312-manylinux_2_34_x86_64.whl
| Download URL | readme_update-0.3.0-cp312-cp312-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 944.8 kB |
| Tags | CPython 3.12 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
d78396b0da0edc840ef6ace27e19ac697ca5058d1ee88025f74bf7c0c8fc725f
|
|
BLAKE2b-256 checksum How to use checksums |
b6665f9665c512f65ad71f6d2a07a84480d000dca0618f5dbdd69a380f1c88d4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | readme_update-0.3.0-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 808.8 kB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
47e7a26c252a12f592d683d58fae84ef5bbcc4032ee1fe3a5844ed516a718006
|
|
BLAKE2b-256 checksum How to use checksums |
3c6550de33028cf6d8d659ce3983ff7f83a809c12fe0c0e813031b3811a40808
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp311-cp311-win_amd64.whl
| Download URL | readme_update-0.3.0-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 832.8 kB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
46ca5d0434955601b8b37a33224be5d55470e49478408982c55126eacfd326e9
|
|
BLAKE2b-256 checksum How to use checksums |
e2a1e1d13f2fd512d947a32049c89cbfb7b663f226dab7d7f99dc25513ed6938
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp311-cp311-manylinux_2_34_x86_64.whl
| Download URL | readme_update-0.3.0-cp311-cp311-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 945.7 kB |
| Tags | CPython 3.11 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
3329b1d203d80f5b50348a5864f478da47ec9a172e4b473663c59ec168a1d181
|
|
BLAKE2b-256 checksum How to use checksums |
2f584bca162b2d3727c15e5a95cb50ae4e23c6a48415ea713e46de72f338b133
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | readme_update-0.3.0-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 810.9 kB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
00da6cc053cfb1f1398d8dba45dda9bd62648d2db3f1206b22c8b47037df1dcf
|
|
BLAKE2b-256 checksum How to use checksums |
898006dd719fbbe54a9b7226d6482585d97a3ab79d753bf3105405dc41f90b34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp310-cp310-win_amd64.whl
| Download URL | readme_update-0.3.0-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 833.0 kB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
f68d55db5983c3443cad51bbee917361ea4ba4de8a98c5d9fdab23a2f4a964f1
|
|
BLAKE2b-256 checksum How to use checksums |
3114a63cc48a662a0aa729b249674acd09ff9465f5d63474b9534fe9da92a5b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp310-cp310-manylinux_2_34_x86_64.whl
| Download URL | readme_update-0.3.0-cp310-cp310-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 946.1 kB |
| Tags | CPython 3.10 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
b023015e4ebd1d294f10c4091485a6fbdf61b03099e85287afca656c3a4d7500
|
|
BLAKE2b-256 checksum How to use checksums |
92f763eb557706f20290d95cf38567bff6cc43ed157b6cadf77a0d7da5e3bc2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency logRelease files / readme_update-0.3.0-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | readme_update-0.3.0-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 811.2 kB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
327c5223bbb3f020d51a4638750821728a64e657eb44bb89190736b5758cdf16
|
|
BLAKE2b-256 checksum How to use checksums |
1517b86ecedc533e9536750d8450fef2c9e03a3e2b17f82211d9ea08099e06dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Nov 11, 2025.
Transparency log
