Skip to main content

Python docstring style checker

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
...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pep257-0.7.0.tar.gz (18.2 kB view hashes)

Uploaded source

Built Distribution

pep257-0.7.0-py2.py3-none-any.whl (18.5 kB view hashes)

Uploaded 2 7

Supported by

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