Metadata-Version: 2.4
Name: reqstool-python-hatch-plugin
Version: 0.2.0
Summary: Hatch plugin to process reqstool-python-decorators when building with Hatch
Project-URL: Homepage, https://reqstool.github.io
Project-URL: Source, https://github.com/reqstool/reqstool-python-hatch-plugin.git
Project-URL: Documentation, https://github.com/reqstool/reqstool-python-hatch-plugin.git
Author: reqstool
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.13
Requires-Dist: hatchling==1.29.0
Requires-Dist: reqstool-python-decorators==0.1.0
Requires-Dist: ruamel-yaml==0.19.1
Description-Content-Type: text/markdown

[![Commit Activity](https://img.shields.io/github/commit-activity/m/reqstool/reqstool-python-hatch-plugin?label=commits&style=for-the-badge)](https://github.com/reqstool/reqstool-python-hatch-plugin/pulse)
[![GitHub Issues](https://img.shields.io/github/issues/reqstool/reqstool-python-hatch-plugin?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-python-hatch-plugin/issues)
[![License](https://img.shields.io/github/license/reqstool/reqstool-python-hatch-plugin?style=for-the-badge&logo=opensourceinitiative)](https://opensource.org/license/mit/)
[![Build](https://img.shields.io/github/actions/workflow/status/reqstool/reqstool-python-hatch-plugin/build.yml?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-python-hatch-plugin/actions/workflows/build.yml)
[![Documentation](https://img.shields.io/badge/Documentation-blue?style=for-the-badge&link=docs)](https://reqstool.github.io)

# Reqstool Python Hatch Plugin

Hatch build hook plugin for [reqstool](https://github.com/reqstool/reqstool-client) that collects decorated code and generates `annotations.yml` during `hatch build`.

## Installation

Add to your `pyproject.toml`:

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

## Usage

Configure the plugin in `pyproject.toml`:

```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](https://github.com/reqstool/reqstool-python-decorators) for processing.

## Documentation

Full documentation can be found [here](https://reqstool.github.io).

## Contributing

See the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md).

## License

MIT License.
