pytest plugin to run pydocstyle
Project Links
Meta
Author: OMOTO Tsukasa
Requires Python: ~=3.9
Classifiers
Development Status
- 3 - Alpha
Intended Audience
- Developers
Topic
- Software Development :: Testing
License
- OSI Approved :: MIT License
Framework
- Pytest
Programming Language
- Python :: 3
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
pytest-pydocstyle
pytest plugin to run pydocstyle
Installation
pip install pytest-pydocstyle
Usage
pytest --pydocstyle ...
For detail, please see pytest -h
after installation.
Configuration
The behavior can be configured in the same style of pydocstyle.
(cf. Configuration — pytest documentation and Configuration Files — pydocstyle documentation)
For example,
[pydocstyle]
convention = numpy
add-ignore = D400,D403
[tool:pytest]
addopts = --pydocstyle
Licence
The MIT License
Copyright (c) 2019 OMOTO Tsukasa
Acknowledgments
Oct 09, 2024
2.4.0
Jan 05, 2023
2.3.2
Oct 28, 2022
2.3.1
Mar 13, 2022
2.3.0
Mar 13, 2022
2.2.1
Aug 10, 2020
2.2.0
Apr 03, 2020
2.1.3
Mar 23, 2020
2.1.2
Mar 23, 2020
2.1.1
Mar 23, 2020
2.1.0
Nov 17, 2019
2.0.0
Nov 17, 2019
1.5.2
Nov 16, 2019
1.5.1
Dec 16, 2018
1.5.0
Nov 15, 2018
1.4.1
Sep 01, 2018
1.4.0
Aug 29, 2018
1.3.3
Apr 23, 2018
1.3.2
Apr 02, 2018
1.3.1
Mar 26, 2018
1.3.0
Mar 20, 2018
1.2.2