Docsweeper
Docsweeper is a linter for version controlled Python code bases that finds potentially outdated docstrings in your source files. For every code token in the file that has a docstring (see PEP 257), Docsweeper will interact with your Git or Mercurial version control system to determine:
in which revision the docstring has last been changed, and
how often the source code that is referenced by the docstring has been altered since that revision.
Used as a stand-alone application or as a plugin for the Flake8 linter, Docsweeper can be integrated into your code check-in or linting process easily and help you quickly determine which docstrings potentially contain obsolete information.
Compatibility
Docsweeper supports Linux, Mac, and Windows platforms that are compatible with Python 3.7 or newer. In addition to a working Python installation, you will also need at least one of the version control systems you intend to use Docsweeper with:
Git v1.7.0 or newer, and/or
Mercurial v5.2 or newer. This is the the first release of Mercurial with official support for Python 3.
Refer to the documentation for more information.
1 maintainer
Metadata
1 maintainer
Release files for docsweeper 1.2.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 | Provenance | Actions |
|---|---|---|---|---|
| docsweeper-1.2.5.tar.gz | 22.5 kB | Without provenance | Details for docsweeper-1.2.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| docsweeper-1.2.5-py3-none-any.whl | Python 3 | none | any | Details for docsweeper-1.2.5-py3-none-any.whl |
Total release size: 55.5 kB
Release files / docsweeper-1.2.5.tar.gz
| Download URL | docsweeper-1.2.5.tar.gz |
|---|---|
| Size | 22.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2a727ea57f208bb7f76d0b4be52abc9fb8d1fe433cb299f00117c0608c8493e1
|
|
BLAKE2b-256 checksum How to use checksums |
86a96d20a50819540be5e6fc0f7737bcb4966d7ee35e28864e916151434279bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.10.4
|
Release files / docsweeper-1.2.5-py3-none-any.whl
| Download URL | docsweeper-1.2.5-py3-none-any.whl |
|---|---|
| Size | 33.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
96f099693dcbd8e558db579af46c1da800139e1e76bd092a2ae54e1c6dfafb43
|
|
BLAKE2b-256 checksum How to use checksums |
a7cb3a42d453b9b435a801f06f00befd1c1fd3f16c0cd053466958cd2961cdf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.10.4
|
Security for docsweeper 1.2.5
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.
