pydocstyle - docstring style checker
====================================
.. image:: https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg
:target: https://github.com/PyCQA/pydocstyle/actions?query=workflow%3A%22Run+tests%22+branch%3Amaster
.. image:: https://readthedocs.org/projects/pydocstyle/badge/?version=latest
:target: https://readthedocs.org/projects/pydocstyle/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/pyversions/pydocstyle.svg
:target: https://pypi.org/project/pydocstyle
.. image:: https://pepy.tech/badge/pydocstyle
:target: https://pepy.tech/project/pydocstyle
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
:target: https://pycqa.github.io/isort/
.. image:: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod
:target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle
:alt: Gitpod ready-to-code
**pydocstyle** is a static analysis tool for checking compliance with Python
docstring conventions.
**pydocstyle** supports most of
`PEP 257 <http://www.python.org/dev/peps/pep-0257/>`_ out of the box, but it
should not be considered a reference implementation.
**pydocstyle** supports Python 3.6+.
Quick Start
-----------
Install
^^^^^^^
.. code::
pip install pydocstyle
Run
^^^
.. code::
$ 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 -
.. image:: https://gitpod.io/button/open-in-gitpod.svg
:target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle
:alt: Open in Gitpod
Before submitting a PR make sure that you run `make all`.
Links
-----
* `Read the full documentation here <https://pydocstyle.org/en/stable/>`_.
* `Fork pydocstyle on GitHub <https://github.com/PyCQA/pydocstyle>`_.
* `PyPI project page <https://pypi.python.org/pypi/pydocstyle>`_.
Raw data
{
"_id": null,
"home_page": "https://www.pydocstyle.org/en/stable/",
"name": "pydocstyle",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Amir Rachum",
"author_email": "amir@rachum.com",
"download_url": "https://files.pythonhosted.org/packages/e9/5c/d5385ca59fd065e3c6a5fe19f9bc9d5ea7f2509fa8c9c22fb6b2031dd953/pydocstyle-6.3.0.tar.gz",
"platform": null,
"description": "pydocstyle - docstring style checker\n====================================\n\n\n.. image:: https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg\n :target: https://github.com/PyCQA/pydocstyle/actions?query=workflow%3A%22Run+tests%22+branch%3Amaster\n\n.. image:: https://readthedocs.org/projects/pydocstyle/badge/?version=latest\n :target: https://readthedocs.org/projects/pydocstyle/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/pyversions/pydocstyle.svg\n :target: https://pypi.org/project/pydocstyle\n\n.. image:: https://pepy.tech/badge/pydocstyle\n :target: https://pepy.tech/project/pydocstyle\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\n :target: https://pycqa.github.io/isort/\n\n.. image:: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod\n :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle\n :alt: Gitpod ready-to-code\n\n**pydocstyle** is a static analysis tool for checking compliance with Python\ndocstring conventions.\n\n**pydocstyle** supports most of\n`PEP 257 <http://www.python.org/dev/peps/pep-0257/>`_ out of the box, but it\nshould not be considered a reference implementation.\n\n**pydocstyle** supports Python 3.6+.\n\n\nQuick Start\n-----------\n\nInstall\n^^^^^^^\n\n.. code::\n\n pip install pydocstyle\n\n\nRun\n^^^\n\n.. code::\n\n $ pydocstyle test.py\n test.py:18 in private nested class `meta`:\n D101: Docstring missing\n test.py:27 in public function `get_user`:\n D300: Use \"\"\"triple double quotes\"\"\" (found '''-quotes)\n test:75 in public function `init_database`:\n D201: No blank lines allowed before function docstring (found 1)\n ...\n\nDevelop\n^^^^^^^\n\nYou can use Gitpod to run pre-configured dev environment in the cloud right from your browser -\n\n.. image:: https://gitpod.io/button/open-in-gitpod.svg\n :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle\n :alt: Open in Gitpod\n \nBefore submitting a PR make sure that you run `make all`.\n\nLinks\n-----\n\n* `Read the full documentation here <https://pydocstyle.org/en/stable/>`_.\n\n* `Fork pydocstyle on GitHub <https://github.com/PyCQA/pydocstyle>`_.\n\n* `PyPI project page <https://pypi.python.org/pypi/pydocstyle>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python docstring style checker",
"version": "6.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36ea99ddefac41971acad68f14114f38261c1f27dac0b3ec529824ebc739bdaa",
"md5": "3475c014e11a43cb2a991c24a659b947",
"sha256": "118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019"
},
"downloads": -1,
"filename": "pydocstyle-6.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3475c014e11a43cb2a991c24a659b947",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 38038,
"upload_time": "2023-01-17T20:29:18",
"upload_time_iso_8601": "2023-01-17T20:29:18.094183Z",
"url": "https://files.pythonhosted.org/packages/36/ea/99ddefac41971acad68f14114f38261c1f27dac0b3ec529824ebc739bdaa/pydocstyle-6.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e95cd5385ca59fd065e3c6a5fe19f9bc9d5ea7f2509fa8c9c22fb6b2031dd953",
"md5": "8fa0c9de748b1107960c61a24d21dadd",
"sha256": "7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1"
},
"downloads": -1,
"filename": "pydocstyle-6.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8fa0c9de748b1107960c61a24d21dadd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 36796,
"upload_time": "2023-01-17T20:29:19",
"upload_time_iso_8601": "2023-01-17T20:29:19.838803Z",
"url": "https://files.pythonhosted.org/packages/e9/5c/d5385ca59fd065e3c6a5fe19f9bc9d5ea7f2509fa8c9c22fb6b2031dd953/pydocstyle-6.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-17 20:29:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pydocstyle"
}
JSON