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 sambhav_kothari from gravatar.com sambhav_kothari

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Amir Rachum
  • Requires: Python >=3.6
Classifiers

Project description

https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg Documentation Status https://img.shields.io/pypi/pyversions/pydocstyle.svg https://pepy.tech/badge/pydocstyle https://img.shields.io/badge/code%20style-black-000000.svg https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 Gitpod ready-to-code

pydocstyle is a static analysis tool for checking compliance with Python docstring conventions.

pydocstyle supports most of PEP 257 out of the box, but it should not be considered a reference implementation.

pydocstyle supports Python 3.6+.

Quick Start

Install

pip install pydocstyle

Run

$ pydocstyle test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:27 in public function `get_user`:
    D300: Use """triple double quotes""" (found '''-quotes)
test:75 in public function `init_database`:
    D201: No blank lines allowed before function docstring (found 1)
...

Develop

You can use Gitpod to run pre-configured dev environment in the cloud right from your browser -

Open in Gitpod

Before submitting a PR make sure that you run make all.

Project details

Verified details

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

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Amir Rachum
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

6.3.0

6.2.3

6.2.2

6.2.1

This version

6.2.0

6.1.1

6.1.0

6.0.0

5.1.1

5.1.0

5.0.2

5.0.1

5.0.0

4.0.1

4.0.0

3.0.0

2.1.1

2.1.0

2.0.0

1.1.1

1.1.0

1.0.0

0.0

Download files

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

Source Distribution

pydocstyle-6.2.0.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

pydocstyle-6.2.0-py3-none-any.whl (37.5 kB view details)

Uploaded Python 3

File details

Details for the file pydocstyle-6.2.0.tar.gz.

File metadata

  • Download URL: pydocstyle-6.2.0.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.6 Linux/5.15.0-1024-azure

File hashes

Hashes for pydocstyle-6.2.0.tar.gz
Algorithm Hash digest
SHA256 b2d280501a4c0d9feeb96e9171dc3f6f7d0064c55270f4c7b1baa18452019fd9
MD5 f2407e7cedc479d9b9278086f3728268
BLAKE2b-256 da1fcd8bb9e67bf4030e183f480b4e6dc917f99b618caebb03f019a6b30a5fc2

See more details on using hashes here.

File details

Details for the file pydocstyle-6.2.0-py3-none-any.whl.

File metadata

  • Download URL: pydocstyle-6.2.0-py3-none-any.whl
  • Upload date:
  • Size: 37.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.6 Linux/5.15.0-1024-azure

File hashes

Hashes for pydocstyle-6.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39573fa08919ac492b063724af39a1afdcfea8cdaa2c7b8018ca0dfff5d7e36f
MD5 6026b09996533a6eb9daf1fdab3564f1
BLAKE2b-256 9010f24113b83880421f62b9d721c4a9f23aca13c0e775d0fdf616927bea813c

See more details on using hashes here.

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