@@ -13,31 +13,31 @@ This provides decorators and collecting of decorated code, formatting it and wri
1313
1414## Installation
1515
16- The package name is ` reqstool-decorators ` .
16+ The package name is ` reqstool-python- decorators ` .
1717
1818* Using pip install:
1919
2020```
21- $pip install reqstool-decorators
21+ $pip install reqstool-python- decorators
2222```
2323
24- ## Using
24+ ## Usage
2525
2626### pyproject.toml
2727
2828* Hatch
2929
3030```
3131dependencies = [
32- "reqstool-decorators == <version>"
32+ "reqstool-python- decorators == <version>"
3333]
3434```
3535
3636* Poetry
3737
3838```
3939[tool.poetry.dependencies]
40- reqstool-decorators = "<version>"
40+ reqstool-python- decorators = "<version>"
4141```
4242
4343### Decorators
@@ -51,12 +51,12 @@ from reqstool-decorators.decorators.decorators import Requirements, SVCs
5151Example usage of the decorators:
5252
5353```
54- @Requirements(REQ_111, REQ_222)
54+ @Requirements(" REQ_111", " REQ_222" )
5555def somefunction():
5656```
5757
5858```
59- @SVCs(SVC_111, SVC_222)
59+ @SVCs(" SVC_111", " SVC_222" )
6060def test_somefunction():
6161```
6262
@@ -65,20 +65,19 @@ def test_somefunction():
6565Import processor:
6666
6767```
68- from reqstool.processors.decorator_processor import ProcessDecorator
68+ from reqstool.processors.decorator_processor import DecoratorProcessor
6969```
7070
7171Main function to collect decorators data and generate yaml file:
7272
7373```
74- process_decorated_data(path_to_python_files)
74+ process_decorated_data(path_to_python_files, output_file )
7575```
7676
77- Here ` path_to_python_files ` is the directories to search through to find decorated code.
77+ ` path_to_python_files ` is the directories to search through to find decorated code.
7878
79- * Note: *
79+ (Optional) ` output_file ` is output file(path) the yaml file is stored to. Default is ` /build/reqstool/annotations.yml ` .
8080
81- Yaml file is saved into the ` /dist ` folder, make sure the folder exists before running the ` process_decorated_data ` function.
8281
8382## License
8483
0 commit comments