PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Python docstring style checker

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Amir.Rachum from gravatar.com Amir.Rachum Avatar for vladimir from gravatar.com vladimir

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Vladimir Keleshev
  • Tags PEP 257, pep257, PEP 8, pep8, docstrings
Classifiers
Report project as malware

Project description

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 pep257

Run

$ pep257 test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:22 in public method `method`:
        D102: Docstring missing
...

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page