docrep
Python package for docstring repetition
Decision gist · record as of 2026-08-14
No. The package is abandoned (last release 2021-02-16) and targets Python versions up to 3.9, with no verification of compatibility with modern Python or current documentation tools. High install friction combined with maintenance risk makes it unsuitable for new projects. Consider actively maintained alternatives if you need docstring deduplication.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Package classifiers indicate support for Python 2.7 and 3.4–3.9; compatibility with later versions is unverified.
- No runtime dependencies, but high install friction suggests potential build or environment issues.
- High install friction with no runtime dependencies.
License · maintenance · safety
Apache-2.0 (permissive) — Licensed under Apache-2.0 (permissive). You may use, modify, and distribute the package freely in commercial and private projects, provided you include the license notice.
last release 2021-02-16 (2005 days) · last repo commit 2021-02-16 · 33 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 98,613 downloads/mo, #13,071 on PyPI
Alternatives
Verify before relying
pip install docrep
import docrep
# Use docrep.DocRep to define and reuse docstring fragments
rep = docrep.DocRep()
rep.define_doc("param_x", "x : int\n The x coordinate")
rep.doc("param_x")- Whether the package works reliably with Python versions beyond 3.9 despite classifier claims only extending to 3.9.
- Whether abandonment since 2021-02-16 has left the package incompatible with modern docstring conventions or current Sphinx versions.
- Concrete examples of how docrep integrates with napoleon, numpy, or reStructuredText docstring formats beyond keyword hints.
What it is and what it does
Docrep is a documentation utility designed for developers building complex, nested Python APIs who want to avoid repeating the same docstring fragments across many functions or classes. It provides a way to define reusable docstring components once and reference them throughout your codebase, reducing maintenance burden and keeping documentation consistent.
The package works by letting you store docstring snippets (parameter descriptions, return value docs, etc.) in a central registry and then inject them into function or method docstrings at documentation-generation time. It integrates with reStructuredText and supports numpy and napoleon docstring conventions. However, the package has not been maintained since 2021-02-16, and its compatibility with modern Python versions and current documentation tooling is uncertain.
Use it for
- Reduce duplication when many functions share the same parameter descriptions or return types in a large library.
- Maintain consistent documentation for repeated patterns across a nested API without manual repetition.
- Generate docstrings programmatically for auto-generated or templated code where manual repetition would be error-prone.
- Centralize and version-control common docstring fragments separately from implementation code.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
No.
The package is abandoned (last release 2021-02-16) and targets Python versions up to 3.9, with no verification of compatibility with modern Python or current documentation tools. High install friction combined with maintenance risk makes it unsuitable for new projects. Consider actively maintained alternatives if you need docstring deduplication.
Install
docrep on PyPI
Before you install
High install friction with no runtime dependencies. The package has been abandoned since 2021-02-16 and has not received updates in years, though it remains marked Production/Stable. Maintenance risk is substantial for a documentation tool where API changes in downstream projects may break workflows.
Package classifiers indicate support for Python 2.7 and 3.4–3.9; compatibility with later versions is unverified. No runtime dependencies, but high install friction suggests potential build or environment issues.
License in practice
Licensed under Apache-2.0 (permissive). You may use, modify, and distribute the package freely in commercial and private projects, provided you include the license notice.
Quickstart
pip install docrep
import docrep
# Use docrep.DocRep to define and reuse docstring fragments
rep = docrep.DocRep()
rep.define_doc("param_x", "x : int\n The x coordinate")
rep.doc("param_x")Verify before relying
- Whether the package works reliably with Python versions beyond 3.9 despite classifier claims only extending to 3.9.
- Whether abandonment since 2021-02-16 has left the package incompatible with modern docstring conventions or current Sphinx versions.
- Concrete examples of how docrep integrates with napoleon, numpy, or reStructuredText docstring formats beyond keyword hints.
Package facts
| License | Apache-2.0 permissive |
| Python support | Not specified |
| Install friction | High. Source build required |
| Runtime dependencies | None |
| Maintenance | Abandoned 2,005 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 98,613 / month, #13,071 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: DevelopersLicense :: OSI Approved :: Apache Software LicenseOperating System :: OS IndependentProgramming Language :: Python :: 2Programming Language :: Python :: 2.7Programming Language :: Python :: 3Programming Language :: Python :: 3.4Programming Language :: Python :: 3.5Programming Language :: Python :: 3.6Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: Documentation |
Evidence: docrep-0.3.2.tar.gz
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 › “docstring reuse”
- docrepDocrep provides utilities to intelligently reuse and deduplicate…
- docstring-inheritanceAutomatically inherits docstrings from parent classes to child…
- pydoclintPydoclint is a Python docstring linter that validates whether…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also docstring-inheritance · autodocsumm · attributes-doc · docstring-to-markdown · docstring-parser · mkdocstrings-python-legacy · mkdocstrings-python · docformatter · docstring-parser-fork · interrogate