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
Report project as malware

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

This version

6.3.0

6.2.3

6.2.2

6.2.1

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.3.0.tar.gz (36.8 kB view details)

Uploaded Source

Built Distribution

pydocstyle-6.3.0-py3-none-any.whl (38.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pydocstyle-6.3.0.tar.gz
  • Upload date:
  • Size: 36.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.6 Linux/5.15.0-1030-azure

File hashes

Hashes for pydocstyle-6.3.0.tar.gz
AlgorithmHash digest
SHA2567ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1
MD58fa0c9de748b1107960c61a24d21dadd
BLAKE2b-256e95cd5385ca59fd065e3c6a5fe19f9bc9d5ea7f2509fa8c9c22fb6b2031dd953

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pydocstyle-6.3.0-py3-none-any.whl
AlgorithmHash digest
SHA256118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019
MD53475c014e11a43cb2a991c24a659b947
BLAKE2b-25636ea99ddefac41971acad68f14114f38261c1f27dac0b3ec529824ebc739bdaa

See more details on using hashes here.