# PyCQA/pydocstyle

docstring style checker

Repository: https://github.com/PyCQA/pydocstyle
Canonical: https://ross.abutalabs.com/products/pydocstyle
Homepage: http://pydocstyle.org
Language: Python
License: MIT
License Family: permissive
Topics: python, linter, docstrings
Archived: true
Last push: 2023-11-03T22:28:46+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 5328, "days_push": 1034, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: archived
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1116, forks 188 (observed 2026-08-28T04:03:38.800603+00:00)

## What it is
pydocstyle is a static analysis CLI tool that checks Python docstrings for compliance with docstring conventions such as PEP 257. It reports style violations like missing docstrings and incorrect quote styles, but the project is officially deprecated in favor of Ruff.

## Use cases
- check python docstrings follow pep 257
- lint docstring style in my python project
- find missing docstrings in python code
- enforce docstring conventions in ci
- catch wrong quote style in docstrings

## When to choose
- maintaining a legacy pipeline already configured with pydocstyle
- you need the exact original D-codes behavior

## When to avoid
- starting a new project - use Ruff instead
- you need support for the latest Python versions
- you want an actively maintained linter

## Facets
- artifact type: cli-tool
- maturity: abandoned
- function: linter, static-site-generator
- domain: developer-tools, documentation, testing
- platform: python, cli, cross-platform
- tags: docstrings, pep257, code-quality, deprecated, static-analysis, python

## Member repositories
- PyCQA/pydocstyle (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:03:38.800603+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T06:41:56.583573+00:00, confidence not recorded.
  - readme: https://github.com/PyCQA/pydocstyle (fetched 2026-08-28T04:03:38.800603+00:00, sha eead8bf94d54)
  - homepage: http://pydocstyle.org (fetched 2026-08-29T12:45:58.707573+00:00, sha c2a555a4a7ea)
  - registry_pypi: https://pypi.org/pypi/pydocstyle/json (fetched 2026-08-29T12:45:58.717392+00:00, sha af808a76ed90)
- Data as of 2026-08-30T08:39:29.467469+00:00.
