docspec-python

What it is and what it does

docspec-python is a parser that converts Python source code into structured docspec objects—a standardized format for representing module, class, function, and data documentation. It uses lib2to3 as its parsing foundation, which means it handles Python syntax reliably without requiring the Python interpreter itself. The package is typically used in documentation generation pipelines, code analysis tools, and introspection systems where you need programmatic access to Python code structure and docstrings.

The package works by reading Python source (from stdin or a file) and emitting docspec data that can be dumped, transformed, or fed into downstream tools. It depends on black for code formatting utilities, docspec for the data model, and nr-util for utility functions. The aging maintenance status (465 days since last release) suggests the core functionality is stable but may not receive rapid updates for new Python features or bug fixes.

Use it for:

• Generate structured documentation from Python source code for doc generation systems.
• Extract API metadata (classes, functions, signatures) for code analysis or IDE tooling.
• Build code introspection pipelines that need reliable Python syntax parsing without executing code.
• Feed docspec data into custom documentation renderers or static analysis tools.
• Audit or catalog Python module structure in large codebases programmatically.

Worth the install?

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

Parses Python source code into structured docspec data, extracting module, class, function, and data documentation metadata using lib2to3.

Yes, if you need reliable Python source parsing into docspec format and can accept aging maintenance. The package has no known vulnerabilities, low install friction, and a stable core function. However, verify the unclear license status before use in proprietary contexts, and be aware that bug fixes or Python feature support may lag behind active projects.

Install

docspec-python on PyPI

pip install docspec-python

uv add docspec-python

poetry add docspec-python

Installing docspec-python

Before you install

Low install friction with a pure-wheel distribution. Maintenance status is aging—last release was 465 days ago—so expect slower response to issues, though the package remains functional for its core parsing task.

License in practice

License status is unclear; no SPDX identifier or raw license text is available in the metadata. Verify the actual license terms in the repository or package source before use in proprietary or restricted contexts.

Quickstart

pip install docspec-python

from docspec_python import parse_python_module
import docspec, sys

docspec.dump_module(parse_python_module(sys.stdin, print_function=False), sys.stdout)

Requires Python 3.8 or later; depends on black, docspec, and nr-util at runtime.

Verify before relying

• Whether the unclear license status reflects a missing metadata entry or an actual licensing ambiguity in the source.
• Current repository health and maintainer responsiveness, given the 465-day gap since last release.

Package facts

Evidence: docspec_python-2.2.2-py3-none-any.whl

Tags

More Documentation packages