reqstool-python-hatch-plugin 0.1.0

Hatch plugin to process reqstool-python-decorators when building with Hatch

Description

This documentation provides information on how to use the Reqstool Hatch Plugin. The plugin is designed to be used with the Hatch build tool and facilitates the integration of the Reqstool Decorators in your project.

Installation

To use the Reqstool Hatch Plugin, follow these steps:

• Update your project dependencies in the pyproject.toml file and ensure that the Reqstool Decorators' dependency is listed as follows;

dependencies = ["reqstool-python-decorators == <version>"]

When you declare this in the pyproject.toml file, you are specifying the required versions for the dependency of the Reqstool Decorators. This ensures that the correct version of the dependencies are used when installing and running your project.

Usage

Configuration

The plugin can be configured through the pyproject.toml file. Configure plugin in pyproject.tomlas follows;

[tool.hatch.build.hooks.reqstool]
dependencies = ["reqstool-python-hatch-plugin == <version>"]
sources = ["src", "tests"]
dataset_directory = "docs/reqstool"
output_directory = "build/reqstool"
test_results = ["build/**/junit.xml"]

It specifies that the reqstool-python-hatch-plugin is a dependency for the build process, and it should be of a specific version.

Further it defines the paths where the plugin should be applied. In this case, it specifies that the plugin should be applied to files in the src and tests directories.