README.md

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.