pydocstyle

What it is and what it does

pydocstyle is a static docstring checker that enforces PEP 257 conventions across your Python codebase. It scans files and reports violations like missing docstrings, incorrect quote styles, and improper blank line placement around docstrings. The tool runs from the command line and integrates into CI/CD pipelines or development workflows to catch documentation style issues early.

The package depends on snowballstemmer for linguistic processing and importlib-metadata for runtime metadata access. It supports Python 3.6 and later, though the project itself has been archived and is no longer actively maintained—the last release was 2023-01-17 and the repository received its final commit on 2023-11-03.

Use it for:

• Enforce consistent docstring formatting across a team's Python codebase during code review or CI/CD checks.
• Identify missing or malformed docstrings in existing projects before documentation generation.
• Validate that public APIs and functions meet PEP 257 documentation standards automatically.
• Integrate into pre-commit hooks to catch docstring style violations before commits are pushed.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

pydocstyle is a static analysis tool that checks Python docstrings for compliance with PEP 257 conventions, reporting style violations in your code.

Yes, but with caution. pydocstyle remains functional for enforcing PEP 257 docstring conventions and has low install friction. However, the project is archived and abandoned—no maintenance since 2023-11-03. Install it if you need a stable, lightweight docstring linter for existing codebases, but be aware that compatibility with future Python versions is not guaranteed and no bug fixes or updates will be released.

Install

pydocstyle on PyPI

pip install pydocstyle

uv add pydocstyle

poetry add pydocstyle

Installing pydocstyle

Before you install

Low install friction with only two lightweight runtime dependencies (snowballstemmer and importlib-metadata). However, the project is archived and abandoned as of 2023-11-03, with no releases since 2023-01-17—maintenance has stopped.

License in practice

MIT license is permissive and imposes no restrictions on use, modification, or distribution in your own projects.

Quickstart

pip install pydocstyle

# Run from command line
pydocstyle mymodule.py

# Or import and use programmatically
from pydocstyle import checker
results = checker.check(['mymodule.py'])

Requires Python 3.6 or later; the project is no longer maintained, so compatibility with Python versions released after 2023-01-17 is not guaranteed.

Verify before relying

• Whether pydocstyle still works correctly with Python 3.10, 3.11, and later versions given the project's abandoned status.
• Whether the tool's PEP 257 implementation remains aligned with current best practices or if newer docstring standards have emerged.
• Active community forks or maintained alternatives that may have superseded this package.

Package facts

Evidence: pydocstyle-6.3.0-py3-none-any.whl

Tags

More Quality Assurance packages