No project description provided
Project description
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.
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.
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 | |
example_usage.py |
||
| :: |
Some line afterwards
blah blah
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file readme_update-0.1.1.tar.gz.
File metadata
- Download URL: readme_update-0.1.1.tar.gz
- Upload date:
- Size: 8.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb8b7ad6e15c8579a8f7f3e89f7ff1609c86c85ae7396da319a0e80886877104
|
|
| MD5 |
99b07a4dc7c43d177c1131b6c690f863
|
|
| BLAKE2b-256 |
9b515742c79ab4902792c4d4dfa657629ade209ec23e0bf57c05a774d886e3fa
|
Provenance
The following attestation bundles were made for readme_update-0.1.1.tar.gz:
Publisher:
publish.yaml on second-ed/readme-update
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
readme_update-0.1.1.tar.gz -
Subject digest:
cb8b7ad6e15c8579a8f7f3e89f7ff1609c86c85ae7396da319a0e80886877104 - Sigstore transparency entry: 270951729
- Sigstore integration time:
-
Permalink:
second-ed/readme-update@50415fbca5712d41afba6bf43b03a6afc4564d96 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/second-ed
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@50415fbca5712d41afba6bf43b03a6afc4564d96 -
Trigger Event:
release
-
Statement type:
File details
Details for the file readme_update-0.1.1-cp313-cp313-macosx_11_0_arm64.whl.
File metadata
- Download URL: readme_update-0.1.1-cp313-cp313-macosx_11_0_arm64.whl
- Upload date:
- Size: 892.6 kB
- Tags: CPython 3.13, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
482142ac7f94339321b6deff1357f2e023429433cec7562b51d0349d92adafa8
|
|
| MD5 |
23f6bc7d53bf97dd7d0fac7d42909b80
|
|
| BLAKE2b-256 |
0313244486108ec68245a11fc6d1d64539be89d10324a53570148a941301832c
|
Provenance
The following attestation bundles were made for readme_update-0.1.1-cp313-cp313-macosx_11_0_arm64.whl:
Publisher:
publish.yaml on second-ed/readme-update
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
readme_update-0.1.1-cp313-cp313-macosx_11_0_arm64.whl -
Subject digest:
482142ac7f94339321b6deff1357f2e023429433cec7562b51d0349d92adafa8 - Sigstore transparency entry: 270951766
- Sigstore integration time:
-
Permalink:
second-ed/readme-update@50415fbca5712d41afba6bf43b03a6afc4564d96 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/second-ed
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@50415fbca5712d41afba6bf43b03a6afc4564d96 -
Trigger Event:
release
-
Statement type:
File details
Details for the file readme_update-0.1.1-cp312-cp312-manylinux_2_34_x86_64.whl.
File metadata
- Download URL: readme_update-0.1.1-cp312-cp312-manylinux_2_34_x86_64.whl
- Upload date:
- Size: 1.1 MB
- Tags: CPython 3.12, manylinux: glibc 2.34+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9c0a1aa00387ec9f066e38e3bceed4121845561ae42a6471014229c56626eb0d
|
|
| MD5 |
e7db2facf24e929d81c0a5affe41d8a2
|
|
| BLAKE2b-256 |
c9418d14e9ceda96cabfee4fbde38b618a68efcab4c0f0397817da9b42a96f6d
|
Provenance
The following attestation bundles were made for readme_update-0.1.1-cp312-cp312-manylinux_2_34_x86_64.whl:
Publisher:
publish.yaml on second-ed/readme-update
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
readme_update-0.1.1-cp312-cp312-manylinux_2_34_x86_64.whl -
Subject digest:
9c0a1aa00387ec9f066e38e3bceed4121845561ae42a6471014229c56626eb0d - Sigstore transparency entry: 270951756
- Sigstore integration time:
-
Permalink:
second-ed/readme-update@50415fbca5712d41afba6bf43b03a6afc4564d96 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/second-ed
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@50415fbca5712d41afba6bf43b03a6afc4564d96 -
Trigger Event:
release
-
Statement type:
File details
Details for the file readme_update-0.1.1-cp39-cp39-win_amd64.whl.
File metadata
- Download URL: readme_update-0.1.1-cp39-cp39-win_amd64.whl
- Upload date:
- Size: 783.3 kB
- Tags: CPython 3.9, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b5c02d1c4578152186e756260a23245a07fad0709df246e472bd416a1a017731
|
|
| MD5 |
8116f0da6cd0fe89dc53e1003290767f
|
|
| BLAKE2b-256 |
1b78920771be527518a013f3ab69250d42d0ed7f85ecc5c426ade87e11028a1b
|
Provenance
The following attestation bundles were made for readme_update-0.1.1-cp39-cp39-win_amd64.whl:
Publisher:
publish.yaml on second-ed/readme-update
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
readme_update-0.1.1-cp39-cp39-win_amd64.whl -
Subject digest:
b5c02d1c4578152186e756260a23245a07fad0709df246e472bd416a1a017731 - Sigstore transparency entry: 270951746
- Sigstore integration time:
-
Permalink:
second-ed/readme-update@50415fbca5712d41afba6bf43b03a6afc4564d96 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/second-ed
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@50415fbca5712d41afba6bf43b03a6afc4564d96 -
Trigger Event:
release
-
Statement type:
