Complete documentation: http://sphinx-needs.readthedocs.io/en/latest/
Attention: sphinxcontrib-needs got renamed to sphinx-needs. This affects also the URLs for documentation and repository:
Introduction
Sphinx-Needs allows the definition, linking and filtering of class-like need-objects, which are by default:
requirements
specifications
implementations
test cases.
This list can be easily customized via configuration (for instance to support bugs or user stories).
A default requirement need looks like:
Layout and style of needs can be highly customized, so that a need can also look like:
Take a look into our tutorial for more pictures and ideas how to use Sphinx-Needs.
For filtering and analyzing needs, Sphinx-Needs provides different, powerful possibilities:
Installation
Using pip
pip install sphinx-needs
If you wish to also use the plotting features of sphinx-needs (see needbar and needpie), you need to also install matplotlib, which is available via the plotting extra:
pip install sphinx-needs[plotting]
Using sources
git clone https://github.com/useblocks/sphinx-needs
cd sphinx-needs
pip install .
Activation
For final activation, please add sphinx_needs to the project’s extension list of your conf.py file.
extensions = ["sphinx_needs",]
Metadata
Release files for sphinx-needs 9.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_needs-9.1.0.tar.gz | 5.9 MB | Without provenance | Details for sphinx_needs-9.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_needs-9.1.0-py3-none-any.whl | Python 3 | none | any | Details for sphinx_needs-9.1.0-py3-none-any.whl |
Total release size: 6.8 MB
Release files / sphinx_needs-9.1.0.tar.gz
| Download URL | sphinx_needs-9.1.0.tar.gz |
|---|---|
| Size | 5.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa12cb45a585ce47cc4a633cb97d0df44fb3107f82ed01eebd729e9e4be518dc
|
|
BLAKE2b-256 checksum How to use checksums |
0a8a77be881c9a5263f57c5ce82bee829f9c37492d372f3a43e171f1dc7b9f9f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / sphinx_needs-9.1.0-py3-none-any.whl
| Download URL | sphinx_needs-9.1.0-py3-none-any.whl |
|---|---|
| Size | 849.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
888fbe9e0b2b6121ef32e254364dbf8d869c7120e9dc4128311cec494c54e106
|
|
BLAKE2b-256 checksum How to use checksums |
d03a8f676729f3c90f1ee8d5d04a01e586386ffe28941c32ac53c7231bc450a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for sphinx-needs 9.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.