Metadata-Version: 2.1
Name: pytest-docstyle
Version: 1.3.3
Summary: pytest plugin to run pydocstyle
Home-page: https://github.com/henry0312/pytest-docstyle
Author: Tsukasa OMOTO
Author-email: henry0312@gmail.com
License: MIT
Description: # pytest-docstyle
        
        [![PyPI version](https://badge.fury.io/py/pytest-docstyle.svg)](https://pypi.org/project/pytest-docstyle/)
        
        [pytest](https://docs.pytest.org/en/latest/) plugin to run [pydocstyle](https://github.com/PyCQA/pydocstyle)
        
        ## Installation
        
        ```sh
        pip install pytest-docstyle
        ```
        
        ## Usage
        
        ```sh
        pytest --docstyle ...
        ```
        
        For detail, please see `pytest -h` after installation.
        
        ## Configuration
        
        You can configure options of pydocstyle with `setup.cfg` (or `pytest.ini`).  
        (cf. [Configuration — pytest documentation](https://docs.pytest.org/en/latest/customize.html))
        
        For example,
        
        ```
        [tool:pytest]
        docstyle_convention = numpy
        docstyle_add_ignore = D400 D403
        ```
        
        ## Licence
        
        The MIT License  
        Copyright (c) 2017 Tsukasa OMOTO
        
        ## Acknowledgments
        
        - [abendebury/pytest-pep257](https://github.com/abendebury/pytest-pep257)
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: Pytest
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: ~=3.5
Description-Content-Type: text/markdown
Provides-Extra: tests
