reqstool-python-decorators

Reqstool Python Decorators

Description

This provides decorators and collecting of decorated code, formatting it and writing to yaml file.

Installation

The package name is reqstool-python-decorators.

• Using pip install:

$pip install reqstool-python-decorators 

Usage

pyproject.toml

• Hatch

dependencies = [
    "reqstool-python-decorators == <version>"
]

• Poetry

[tool.poetry.dependencies]
reqstool-python-decorators = "<version>"

Decorators

Import decorators:

from reqstool-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():

Processor

Import processor:

from reqstool.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.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.