Reqstool Python Decorators
Project description
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.
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
Built Distribution
Close
Hashes for reqstool_python_decorators-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ed2daffba17f0ad611eabc1faca65bb6b6530b6fabdd0260dc9862e33eb9ee9 |
|
MD5 | c8ce5c7ea3d7a74c962f3b9ca2025e8c |
|
BLAKE2b-256 | 13d59e7bed202dbbfb1c8f13c827c91e3e98c40401da88e677eb95df392cffb9 |
Close
Hashes for reqstool_python_decorators-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9de3940a6261ac59c09e25475cfae2939b1fccaa9e90466bed46b8a75f0a7e2 |
|
MD5 | 8f2ae3941d5371b34023194948ae754a |
|
BLAKE2b-256 | e1929ab0791360807d219648023f10bff779eb7a7df8ba4de3ff5bfe3950c36d |