From bdb08963395ad60a7596c4d60f2cde51eb2d0238 Mon Sep 17 00:00:00 2001 From: David Mortensen <156092822+lfvdavid@users.noreply.github.com> Date: Tue, 3 Mar 2026 14:52:14 +0100 Subject: [PATCH 1/2] feat: update readme Signed-off-by: David Mortensen <156092822+lfvdavid@users.noreply.github.com> --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index adc9ea6..d42ff52 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,23 @@ The plugin can be configured through the `pyproject.toml` file. Configure plugin ```toml [tool.hatch.build.hooks.reqstool] -dependencies = ["reqstool-python-hatch-plugin == "] sources = ["src", "tests"] +test_results = "build/**/junit.xml" dataset_directory = "docs/reqstool" output_directory = "build/reqstool" -test_results = ["build/**/junit.xml"] ``` +And under `requires` in `[build-system]´ you need to add the plugin with the version, see example: + +```toml +[build-system] +requires = [ + "hatchling", + "reqstool-python-hatch-plugin==", +] +``` + + 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. From 69e62f68bdaa585d840670bc5a2f63a5b791c359 Mon Sep 17 00:00:00 2001 From: David Mortensen <156092822+lfvdavid@users.noreply.github.com> Date: Tue, 3 Mar 2026 14:53:28 +0100 Subject: [PATCH 2/2] feat: update readme Signed-off-by: David Mortensen <156092822+lfvdavid@users.noreply.github.com> --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d42ff52..41de0f1 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,9 @@ 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 == "] + +```toml +dependencies = ["reqstool-python-decorators=="] ``` 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. @@ -39,7 +40,7 @@ dataset_directory = "docs/reqstool" output_directory = "build/reqstool" ``` -And under `requires` in `[build-system]´ you need to add the plugin with the version, see example: +And under `requires` in `[build-system]` you need to add the plugin with the version, see example; ```toml [build-system]