docstr-coverage
Utility for examining python source files to ensure proper documentation. Lists missing docstrings, and calculates overall docstring coverage percentage rating.
Decision gist · record as of 2026-08-14
Yes, if you need to audit or enforce docstring coverage in Python projects. The tool is straightforward, has no security vulnerabilities, and low install friction. However, maintenance is dormant (last release May 2024, no commits for 829 days), so verify compatibility with your Python version before relying on it for critical CI workflows. For one-off audits or pre-commit integration in stable codebases, it's a solid choice.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low install friction with four lightweight runtime dependencies (click, PyYAML, tqdm, importlib-resources).
- Maintenance is dormant—last release was 2024-05-07 and no commits for 829 days—but the repository remains active and unarchived.
License · maintenance · safety
MIT (permissive) — MIT license permits commercial and private use with minimal restrictions; you must include a copy of the license and retain copyright notices.
last release 2024-05-07 (829 days) · last repo commit 2024-12-28 · 104 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 190,657 downloads/mo, #9,903 on PyPI
Alternatives
Verify before relying
pip install docstr-coverage
# Command-line usage:
docstr-coverage /path/to/project
# Or as a library:
from docstr_coverage import get_docstring_coverage
coverage = get_docstring_coverage(['file.py'])- Whether dormant maintenance (829 days since last release) affects compatibility with recent Python versions beyond 3.12
- Performance characteristics on large codebases or deeply nested directory structures
What it is and what it does
docstr-coverage is a command-line tool and Python library that scans your source code to identify which functions, classes, methods, and modules lack docstrings. It walks your project recursively, counts what's documented and what's missing, and reports both per-file and aggregate coverage percentages with a letter grade. You run it as a CLI tool pointing at a file or directory, configure it via YAML, or import its API into your own code to get structured coverage data.
The tool is designed to help enforce documentation standards in teams and projects. It supports fine-grained filtering—you can skip magic methods, private functions, properties, or entire file patterns via regex—and lets you override its analysis with inline comments for inherited or deliberately undocumented code. It integrates into pre-commit hooks, can generate SVG badges for README files, and supports both strict pass/fail thresholds and silent percentage-only output for CI pipelines.
Use it for
- Audit a new library or codebase to understand how well-documented it is before deciding to use or maintain it.
- Enforce minimum documentation standards in CI/CD by failing builds when docstring coverage drops below a threshold.
- Generate a coverage badge to display in a project's README as a visual indicator of documentation quality.
- Integrate into pre-commit hooks to catch undocumented functions and classes before they reach version control.
- Measure documentation debt over time by running the tool on releases and tracking coverage trends.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need to audit or enforce docstring coverage in Python projects.
The tool is straightforward, has no security vulnerabilities, and low install friction. However, maintenance is dormant (last release May 2024, no commits for 829 days), so verify compatibility with your Python version before relying on it for critical CI workflows. For one-off audits or pre-commit integration in stable codebases, it's a solid choice.
Install
docstr-coverage on PyPI
Before you install
Low install friction with four lightweight runtime dependencies (click, PyYAML, tqdm, importlib-resources). Maintenance is dormant—last release was 2024-05-07 and no commits for 829 days—but the repository remains active and unarchived.
License in practice
MIT license permits commercial and private use with minimal restrictions; you must include a copy of the license and retain copyright notices.
Quickstart
pip install docstr-coverage
# Command-line usage:
docstr-coverage /path/to/project
# Or as a library:
from docstr_coverage import get_docstring_coverage
coverage = get_docstring_coverage(['file.py'])Verify before relying
- Whether dormant maintenance (829 days since last release) affects compatibility with recent Python versions beyond 3.12
- Performance characteristics on large codebases or deeply nested directory structures
Package facts
| License | MIT permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesclickPyYAMLtqdmimportlib-resources |
| Maintenance | Dormant 829 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 190,657 / month, #9,903 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | License :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Software DevelopmentTopic :: Software Development :: DocumentationTopic :: Software Development :: Libraries :: Python ModulesTopic :: Software Development :: Quality AssuranceTopic :: Utilities |
Evidence: docstr_coverage-2.3.2-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “missing docstring detection”
- docstr-coverageMeasures docstring coverage in Python source code by scanning for…
- interrogateInterrogate scans a Python codebase to measure and report docstring…
- pydocstylepydocstyle is a static analysis tool that checks Python docstrings…
Give your agent the search over MCP, or paste the wish link into any chat.
More Software Development packages
Provides backported and experimental type hints for Python 3.9+, allowing use of newer typing features on older Python versions and enabling early experimentation with type system PEPs before they enter the standard library.
NumPy provides an N-dimensional array object and a comprehensive suite of mathematical, linear algebra, Fourier transform, and random number functions for scientific computing in Python.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Distlib provides low-level packaging utilities for building, distributing, and managing Python software—including metadata handling, version specifiers, wheel support, script installation, and dependency resolution.
See also interrogate · docstring-inheritance · docformatter · coverage-badge · docstring-parser · attributes-doc · pydocstyle · pydocstringformatter · darglint · overrides