readme-doctor
A zero-dependency CLI that scores a README.md out of 100 and lists concrete fixes as JSON. It can also generate a skeleton for the sections that are missing.
Landing page: https://madhavarora-hub.github.io/readme-doctor/
Install
Requires Python 3.8+. No dependencies.
git clone https://github.com/madhavarora-hub/readme-doctor
cd readme-doctor
Usage
python cli.py README.md # score + fixes (JSON)
python cli.py README.md --template # skeleton for failing checks
python server.py 8080 # local HTTP API: POST /score
python x402_server.py 8402 # x402-paywalled API (USDC on Base)
Use it in CI by failing the build when the score is under a threshold (see action.yml).
Contributing
Pull requests are welcome. Open an issue first to discuss changes.
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for readme-doctor 0.1.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 | Provenance | Actions |
|---|---|---|---|---|
| readme_doctor-0.1.0.tar.gz | 2.7 kB | With provenance | Details for readme_doctor-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| readme_doctor-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for readme_doctor-0.1.0-py3-none-any.whl |
Total release size: 6.0 kB
Release files / readme_doctor-0.1.0.tar.gz
| Download URL | readme_doctor-0.1.0.tar.gz |
|---|---|
| Size | 2.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d6b947e4b40ff78833c1f19cfc6b6376cf976f73df66470bf28a93921bdd0d8d
|
|
BLAKE2b-256 checksum How to use checksums |
2d4e33a29d8d49b6f89f0de12ab3bdedc78ce315c9db03751651369ff4e0c03f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Oct 30, 2026.
Transparency logRelease files / readme_doctor-0.1.0-py3-none-any.whl
| Download URL | readme_doctor-0.1.0-py3-none-any.whl |
|---|---|
| Size | 3.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bb13d07e58fbb8e6f140accfcf2c9d3d8970156efbe84b60898337a12f725f88
|
|
BLAKE2b-256 checksum How to use checksums |
90ea405c043c7153e9e269fbf9dd339ef98f9fa8817be8b07d8378d87838acc2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Oct 30, 2026.
Transparency logSecurity for readme-doctor 0.1.0
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for readme_doctor-0.1.0.tar.gz
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 Oct 30, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
