tooprolix
Less narration. More signal.
Deterministic control over comments and docstrings in Python repositories.
Coding agents over-explain. Comments grow into essays, docstrings restate the code, and the same
rationale quietly spreads across five files. tooprolix turns that into TPX diagnostics you can
act on. It reads only comments and docstrings, never rewrites your why, and leaves the call to
you.
Quick start
Run tooprolix without installing it with uv:
$ uvx tooprolix check .
src/config.py:1-26: TPX002 docstring is 243 words long, over the 200-word limit — shorten it, or mark it with `# !TPX002` on the line above it
Found 1 findings (TPX002: 1).
Each finding points to path:start-end, so you know how big the block is before you open it.
For an existing uv project, pin the tool as a development dependency and run it through uv:
$ uv add --dev tooprolix
$ uv run tooprolix check .
And when the whole tree came back clean:
$ uvx tooprolix check .
All checks passed!
Exit codes are the contract: 0 clean, 1 findings, 2 could not start. A tree that was not read
whole never exits 0. See the CLI contract.
Rules at a glance
| Code | Detects | Status |
|---|---|---|
TPX001 |
A comment run longer than its word limit | Released |
TPX002 |
A docstring longer than its word limit | Released |
TPX003 |
One explanation repeated across comments and docstrings, reported once with every place it appears | Released |
tooprolix --rules prints this table; tooprolix --version prints the version and the date of the
commit it was built from.
Some prose earns its length. Put a marker on the line directly above the block:
# !TPX003
# The retry contract is restated here on purpose, so this module can be read on
# its own without opening the client it talks to.
Several codes, blanket suppression, and repository-wide config live in rules and configuration.
Validation
Rules are exercised on six pinned real repositories agent frameworks and mature libraries not only synthetic fixtures. Every threshold is read off that corpus rather than chosen by taste, and critical guards are mutation-proved: a test that stays green when its guarantee is broken is deleted, not kept for the count.
Why tooprolix
- Repository-wide. It finds one explanation repeated across otherwise unrelated files.
- Deterministic. The same source produces the same ordered findings, byte for byte.
- Local. No model calls, no network, no probabilistic output.
Documentation
| CLI and exit-code contract | Addresses, output channels, colour, exit codes, JSON schema |
| Rules and configuration | Thresholds, suppression markers, pyproject.toml |
corpus/REPORT.md |
The corpus, the measurements, the open questions |
| CONTRIBUTING.md | Toolchain, gates, commit and release conventions |
Contributing
Run make help for the task list, and see CONTRIBUTING.md for the toolchain and
the gates CI requires.
Metadata
Release files for tooprolix 0.5.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tooprolix-0.5.5.tar.gz | 478.5 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tooprolix-0.5.5-py3-none-win_amd64.whl | Python 3 | none | Windows x86-64 | Details |
| tooprolix-0.5.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | Python 3 | none | Linux glibc 2.17+ x86-64 | Details |
| tooprolix-0.5.5-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details |
Total release size: 5.4 MB
Release files / tooprolix-0.5.5.tar.gz
| Download URL | tooprolix-0.5.5.tar.gz |
|---|---|
| Size | 478.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
06d8c251896d8f6951487a207315e1f4025a3e7bd1a532e274a9e6e61a1f4a20
|
|
BLAKE2b-256 checksum How to use checksums |
59d183ff731e348e3503ef2b21fdfee079c8fcaf630daf6e0b81654c386b2527
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 19, 2026.
Transparency logRelease files / tooprolix-0.5.5-py3-none-win_amd64.whl
| Download URL | tooprolix-0.5.5-py3-none-win_amd64.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
40719d434986b14090a928708954196b4604a8631988ac40719dcb5255f33848
|
|
BLAKE2b-256 checksum How to use checksums |
15f05de5c93c4dff45ff14346e6eea8329465d5aa8cc69b8ed3c991410b0c00d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 19, 2026.
Transparency logRelease files / tooprolix-0.5.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | tooprolix-0.5.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
5a7cf4bc5ad5dc8d9d793609566085ba3cdaff09c22ee44ffcadc4e98248ff5c
|
|
BLAKE2b-256 checksum How to use checksums |
70d99b6956588ffda17dae7199e1e5c18f10a096941c4e2409a7955410a2a698
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 19, 2026.
Transparency logRelease files / tooprolix-0.5.5-py3-none-macosx_11_0_arm64.whl
| Download URL | tooprolix-0.5.5-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 1.6 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
34ce000db6007fd64ed0040adfbe18c5c5319c89fceefa870a7417db6cb1f2d8
|
|
BLAKE2b-256 checksum How to use checksums |
c46141f731ed1d48d1ea52e69a480131e3f070a34a0d53bca37d4750a6fbc752
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 19, 2026.
Transparency log