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

This version

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

Uploaded Source

Built Distribution

pydocstyle-6.2.3-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pydocstyle-6.2.3.tar.gz
  • Upload date:
  • Size: 36.5 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.3.tar.gz
Algorithm Hash digest
SHA256 d867acad25e48471f2ad8a40ef9813125e954ad675202245ca836cb6e28b2297
MD5 de59061690a46a9ca79f50b376d5094e
BLAKE2b-256 1eb67d1de9e068d5804222698086295363cd8fb99c79146c59431058c9c17150

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pydocstyle-6.2.3-py3-none-any.whl
  • Upload date:
  • Size: 37.7 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a04ed1e6fe0be0970eddbb1681a7ab59b11eb92729fdb4b9b24f0eb11a25629e
MD5 bba1f80836b898250523e0bf455b02bd
BLAKE2b-256 2f4725f4c4e1b7bfe1d254ab94a256607fac14185b5c2e7521beb50b90e3ed58

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