PEP 257 docstring style checker
pep257 is a static analysis tool for checking compliance with Python PEP 257.
The framework for checking docstring style is flexible, and custom checks can be easily added, for example to cover NumPy docstring conventions.
pep257 supports Python 2.6, 2.7, 3.2, 3.3, 3.4, pypy and pypy3.
Quick Start
Install
pip install pep257Run
$ pep257 test.py
test.py:18 in private nested class `meta`:
D101: Docstring missing
test.py:22 in public method `method`:
D102: Docstring missing
...Links
2 maintainers
Metadata
2 maintainers
Release files for pep257 0.7.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 |
|---|---|---|---|---|
| pep257-0.7.0.tar.gz | 18.2 kB | Without provenance | Details for pep257-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pep257-0.7.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for pep257-0.7.0-py2.py3-none-any.whl |
Total release size: 36.7 kB
Release files / pep257-0.7.0.tar.gz
| Download URL | pep257-0.7.0.tar.gz |
|---|---|
| Size | 18.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f3d67547f5617a9cfeb4b8097ed94a954888315defaf6e9b518ff1719363bf03
|
|
BLAKE2b-256 checksum How to use checksums |
0337872af099c9864f7584bad9a561f6493d5d5eca9fc2b14c7d32407c90c639
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / pep257-0.7.0-py2.py3-none-any.whl
| Download URL | pep257-0.7.0-py2.py3-none-any.whl |
|---|---|
| Size | 18.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
d26cd2a4f572e0592f6967277136f581f924a4fe2aa38dcb7d4e532232689e80
|
|
BLAKE2b-256 checksum How to use checksums |
ec31e432e1aa35f692e3f6865fe07194f32536ec073ec7ad809cd3e7cb1a2b1a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for pep257 0.7.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.
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.
