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-decorators
.
- Using pip install:
$pip install reqstool-decorators
Using
pyproject.toml
- Hatch
dependencies = [
"reqstool-decorators == <version>"
]
- Poetry
[tool.poetry.dependencies]
reqstool-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 ProcessDecorator
Main function to collect decorators data and generate yaml file:
process_decorated_data(path_to_python_files)
Here path_to_python_files
is the directories to search through to find decorated code.
Note:
Yaml file is saved into the /dist
folder, make sure the folder exists before running the process_decorated_data
function.
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | abe872fd6889d9db2dfde25951a4029bab4f28b4689081a093b3450d197e8a09 |
|
MD5 | 963abbfc12ce7c050c02bfc908253fe0 |
|
BLAKE2b-256 | b6f510b39a1df603995132e6a2c1397ce63f53fde1cfcd92554d0e00bf96421a |
Close
Hashes for reqstool_python_decorators-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57b1182b9eb54faa1ef2801e8f9f708495b3d558dcc0cb8dabb789526d8fef00 |
|
MD5 | 1ce92839133ca3be0718c1649d4df179 |
|
BLAKE2b-256 | d40a1bf84a54fe499225fad67874e5a34f45e6b456846ce0b875a0f206ef3332 |