Skip to main content

Reqstool Python Decorators

Project description

Commit Activity GitHub Issues License Build Documentation

Reqstool Python Decorators

Python decorators for reqstool requirements traceability. Provides @Requirements and @SVCs decorators for linking Python code to requirements and software verification cases.

Prerequisites

  • Python >= 3.13

Installation

pip install reqstool-python-decorators

Usage

from reqstool_python_decorators.decorators.decorators import Requirements, SVCs

@Requirements("REQ_111", "REQ_222")
def somefunction():
    pass

@SVCs("SVC_111", "SVC_222")
def test_somefunction():
    pass

Processor

from reqstool_python_decorators.processors.decorator_processor import DecoratorProcessor

# Collect decorators and generate annotations.yml
process_decorated_data(path_to_python_files, output_file)

Used together with the Hatch Plugin or Poetry Plugin.

Documentation

Full documentation can be found here.

Contributing

See the organization-wide CONTRIBUTING.md.

License

MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reqstool_python_decorators-0.1.0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reqstool_python_decorators-0.1.0-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file reqstool_python_decorators-0.1.0.tar.gz.

File metadata

File hashes

Hashes for reqstool_python_decorators-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c810db0e2c7a4dac82ba7af53481fb8eda342af494f033e241b0d5ffc9f35ad1
MD5 6419d26c22dfc3816230cd67941ea106
BLAKE2b-256 e1afdcc5f52674d3120f71251a91eba4c4622e91057b9b14ed513746fa0e9cea

See more details on using hashes here.

Provenance

The following attestation bundles were made for reqstool_python_decorators-0.1.0.tar.gz:

Publisher: publish_pypi_prod.yml on reqstool/reqstool-python-decorators

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file reqstool_python_decorators-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for reqstool_python_decorators-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a12819da88fd3a39b1eda27671f00c61dc925f9a1bb88b15ff5e90c576563498
MD5 e02ec787e7b8f4ffb42f018258718c7a
BLAKE2b-256 366566fe8b1ce9400d465cb342bb5b542acf8130653cb9d6ffc34e21bbf4b589

See more details on using hashes here.

Provenance

The following attestation bundles were made for reqstool_python_decorators-0.1.0-py3-none-any.whl:

Publisher: publish_pypi_prod.yml on reqstool/reqstool-python-decorators

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page