This provides decorators and collecting of decorated code, formatting it and writing to yaml file.
- Python >= 3.13
The package name is reqstool-python-decorators.
- Using pip install:
$pip install reqstool-python-decorators
- Hatch
dependencies = [
"reqstool-python-decorators == <version>"
]
- Poetry
[tool.poetry.dependencies]
reqstool-python-decorators = "<version>"
Import decorators:
from reqstool_python_decorators.decorators.decorators import Requirements, SVCs
Example usage of the decorators:
@Requirements("REQ_111", "REQ_222")
def somefunction():
@SVCs("SVC_111", "SVC_222")
def test_somefunction():
Import processor:
from reqstool_python_decorators.processors.decorator_processor import DecoratorProcessor
Main function to collect decorators data and generate yaml file:
process_decorated_data(path_to_python_files, output_file)
path_to_python_files is the directories to search through to find decorated code.
(Optional) output_file is output file(path) the yaml file is stored to. Default is /build/reqstool/annotations.yml.
This project is licensed under the MIT License - see the LICENSE.md file for details.