pytest-pydocstyle 2.4.0


pip install pytest-pydocstyle

  Latest version

Released: Oct 09, 2024

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

PyPI version

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

Extras:
Dependencies:
pytest (>=7.0)
pydocstyle