Skip to main content
Help us improve Python packaging – donate today!

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

Release history Release notifications

This version
History Node

0.7.0

History Node

0.6.0

History Node

0.5.0

History Node

0.4.1

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.2.4

History Node

0.2.0

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pep257-0.7.0-py2.py3-none-any.whl (18.5 kB) Copy SHA256 hash SHA256 Wheel 2.7 Oct 9, 2015
pep257-0.7.0.tar.gz (18.2 kB) Copy SHA256 hash SHA256 Source None Oct 9, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page