Skip to content

reqstool/reqstool-python-hatch-plugin

Commit Activity GitHub Issues License Build Documentation

Reqstool Python Hatch Plugin

Hatch build hook plugin for reqstool that collects decorated code and generates annotations.yml during hatch build.

Installation

Add to your pyproject.toml:

[build-system]
requires = [
  "hatchling",
  "reqstool-python-hatch-plugin==<version>",
]

Usage

Configure the plugin in pyproject.toml:

[tool.hatch.build.hooks.reqstool]
sources = ["src", "tests"]
test_results = "build/**/junit.xml"
dataset_directory = "docs/reqstool"
output_directory = "build/reqstool"

The plugin uses reqstool-python-decorators for processing.

Documentation

Full documentation can be found here.

Contributing

See the organization-wide CONTRIBUTING.md.

License

MIT License.