pydocstyle

Python docstring style checker

These details have not been verified by PyPI

Project links

Development Status
- 5 - Production/Stable
Environment
- Console
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language

Project description

https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg

https://img.shields.io/pypi/pyversions/pydocstyle.svg

https://img.shields.io/badge/code%20style-black-000000.svg

https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336

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 -

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

Project details

These details have not been verified by PyPI

Project links

Development Status
- 5 - Production/Stable
Environment
- Console
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language

Release history Release notifications | RSS feed

6.3.0

Jan 17, 2023

6.2.3

Jan 8, 2023

6.2.2

Jan 3, 2023

This version

6.2.1

Jan 3, 2023

6.2.0

Jan 2, 2023

6.1.1

May 17, 2021

6.1.0

May 17, 2021

6.0.0

Mar 18, 2021

5.1.1

Aug 29, 2020

5.1.0

Aug 22, 2020

5.0.2

Jan 10, 2020

5.0.1

Dec 9, 2019

5.0.0

Dec 9, 2019

4.0.1

Aug 15, 2019

4.0.0

Jul 6, 2019

3.0.0

Oct 14, 2018

2.1.1

Oct 9, 2017

2.1.0

Oct 8, 2017

2.0.0

Apr 18, 2017

1.1.1

Oct 4, 2016

1.1.0

Sep 29, 2016

1.0.0

Jan 30, 2016

0.0

Jan 22, 2016

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

Uploaded Jan 3, 2023 Source

Built Distribution

pydocstyle-6.2.1-py3-none-any.whl (37.6 kB view details)

Uploaded Jan 3, 2023 Python 3

File details

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

File metadata

Download URL: pydocstyle-6.2.1.tar.gz
Upload date: Jan 3, 2023
Size: 36.4 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.1.tar.gz
Algorithm	Hash digest
SHA256	`5ddccabe3c9555d4afaabdba909ca2de4fa24ac31e2eede4ab3d528a4bcadd52`
MD5	`ae3b1019eb9a3387603cf8aaed30a218`
BLAKE2b-256	`b7c701674c093a29cc83261d2cd554dd9d0debf8cfad061c05359a5d18562863`

See more details on using hashes here.

File details

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

File metadata

Download URL: pydocstyle-6.2.1-py3-none-any.whl
Upload date: Jan 3, 2023
Size: 37.6 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.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`e034023706489a5786778d21bd25e951052616b260d83e163f09d559dcd647b9`
MD5	`a79aae231d5956eda6ecd4b3757416e0`
BLAKE2b-256	`1e4a70a55fe6dada5acf640b202a4c2cda39a74cc51222edd44154c914600e9d`