sphinx-needs
Sphinx needs extension for managing needs/requirements and specifications
Decision gist · record as of 2026-08-14
Yes. Sphinx-Needs is actively maintained, has no known vulnerabilities, uses a permissive MIT license, and solves a real problem for teams that need to embed requirement traceability in their documentation. Install friction is low and Python 3.10 or later support is current. Use it if your project needs to track and link requirements, specifications, or similar structured objects within Sphinx documentation.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- Sphinx must be installed and configured in your documentation project.
- Low install friction; pure Python wheel.
License · maintenance · safety
permissive license (permissive) — Licensed under MIT (permissive), so you can use, modify, and distribute freely with minimal restrictions.
last release 2026-08-11 (3 days) · last repo commit 2026-08-14 · 297 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 295,162 downloads/mo, #7,930 on PyPI
Alternatives
Verify before relying
pip install sphinx-needs
# In conf.py:
extensions = ["sphinx_needs"]
# In your .rst file:
.. req:: REQ
:title: System shall process data
:status: open- Whether the plotting extra (matplotlib) is required for most use cases or optional for advanced visualization only.
- Performance characteristics when managing large numbers of needs in a single project.
- Whether custom need types can reference external data sources or are limited to inline definitions.
What it is and what it does
Sphinx-Needs extends Sphinx documentation with a system for defining and managing structured objects—requirements, specifications, implementations, and test cases—directly within your documentation source. You define these objects using simple directives, link them together, and then query and visualize them across your entire documentation build. The extension provides filtering, table generation, flow diagrams, and pie charts to analyze your needs, making it useful for projects that need to track requirements alongside their documentation.
The package is built on top of Sphinx and integrates with its standard build pipeline. It depends on requests, jsonschema-rs, and several other utilities. You activate it by adding it to your Sphinx conf.py extensions list, then use custom directives in your reStructuredText files to declare and link needs. The visualization and filtering features help teams maintain traceability between requirements and implementation across documentation.
Use it for
- Track system requirements and specifications in technical documentation alongside implementation details.
- Generate traceability matrices and requirement-to-test-case mappings for compliance and verification workflows.
- Visualize dependencies and relationships between requirements using flow diagrams and tables.
- Manage custom need types tailored to your project's workflow beyond the default requirement types.
- Filter and query needs by status, priority, or custom attributes to generate reports from documentation.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Sphinx-Needs is actively maintained, has no known vulnerabilities, uses a permissive MIT license, and solves a real problem for teams that need to embed requirement traceability in their documentation. Install friction is low and Python 3.10 or later support is current. Use it if your project needs to track and link requirements, specifications, or similar structured objects within Sphinx documentation.
Install
sphinx-needs on PyPI
Before you install
Low install friction; pure Python wheel. Active maintenance with a release 3 days ago. Requires Python 3.10 or later and 9 runtime dependencies including sphinx and requests.
Requires Python 3.10 or later. Sphinx must be installed and configured in your documentation project.
License in practice
Licensed under MIT (permissive), so you can use, modify, and distribute freely with minimal restrictions.
Quickstart
pip install sphinx-needs
# In conf.py:
extensions = ["sphinx_needs"]
# In your .rst file:
.. req:: REQ
:title: System shall process data
:status: openVerify before relying
- Whether the plotting extra (matplotlib) is required for most use cases or optional for advanced visualization only.
- Performance characteristics when managing large numbers of needs in a single project.
- Whether custom need types can reference external data sources or are limited to inline definitions.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release <4,>=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 9 packagessphinxrequests-filerequestsjsonschema-rssphinx-data-viewersphinxcontrib-jquerytomlityping-extensionsminijinja |
| Maintenance | Actively maintained 3 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 295,162 / month, #7,930 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/StableFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Utilities |
Evidence: sphinx_needs-8.3.1-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 › “sphinx requirements management”
- sphinx-needsSphinx-Needs is a Sphinx extension that lets you define, link, and…
- sphinx-commentsIntegrates third-party commenting and annotation services into…
- sphinx-multiversionSphinx extension that builds and serves multiple versions of…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also sphinx-issues · sphinx-substitution-extensions · sphinx-panels · sphinx_design · sphinx-codeautolink · sphinx-click · sphinx_mdinclude · sphinxcontrib-bibtex · sphinx-favicon · sphobjinv