Configuration
The plugin is configured in your pyproject.toml file under [tool.reqstool].
Complete Configuration Example
[tool.poetry.dependencies]
reqstool-python-decorators = "<version>"
[tool.reqstool]
# Directories to scan for decorators
# Default: ["src", "tests"]
sources = ["src", "tests"]
# Test result file pattern(s)
# Default: ["build/**/junit.xml"]
test_results = ["build/**/junit.xml"]
# Directory containing requirements.yml and optional files
# Default: "docs/reqstool"
dataset_directory = "docs/reqstool"
# Output directory for generated annotations
# Default: "build/reqstool"
output_directory = "build/reqstool"Configuration Parameters
sources
Directories to scan for @Requirements and @SVCs decorators.
Defaults to ["src", "tests"].
sources = ["src", "tests"]test_results
Path or pattern(s) for test result files (JUnit XML).
Defaults to ["build/**/junit.xml"].
test_results = ["build/**/junit.xml"]