Metadata-Version: 1.2
Name: pydocstyle
Version: 5.0.1
Summary: Python docstring style checker
Home-page: https://github.com/PyCQA/pydocstyle/
Author: Amir Rachum
Author-email: amir@rachum.com
License: MIT
Description: pydocstyle - docstring style checker
        ====================================
        
        
        .. image:: https://travis-ci.org/PyCQA/pydocstyle.svg?branch=master
            :target: https://travis-ci.org/PyCQA/pydocstyle
        
        .. image:: https://ci.appveyor.com/api/projects/status/40kkc366bmrrttca/branch/master?svg=true
            :target: https://ci.appveyor.com/project/Nurdok/pydocstyle/branch/master
        
        .. 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
        
        
        **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.5, 3.6, 3.7 and 3.8.
        
        
        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)
            ...
        
        
        Links
        -----
        
        * `Read the full documentation here <http://pydocstyle.org>`_.
        
        * `Fork pydocstyle on GitHub <http://github.com/PyCQA/pydocstyle>`_.
        
        * `PyPI project page <https://pypi.python.org/pypi/pydocstyle>`_.
        
Keywords: pydocstyle,PEP 257,pep257,PEP 8,pep8,docstrings
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.5
