Reqstool Python Poetry Plugin
Project description
Reqstool Python Poetry Plugin
Description
This provides a generic plugin for Poetry that runs during the build process.
The plugin collects decorated code, formatting it and writing it to a annotations.yml file saved to the build/reqstool/
folder, utilizing the reqstool-python-decorators
package for the processing.
Installation
Plugin
The package name is reqstool-python-poetry-plugin
.
- Using poetry:
$poetry add reqstool-python-poetry-plugin
- pip install (unsure if working as intended):
$pip install reqstool-python-poetry-plugin
Dependencies
reqstool-decorators
The plugin reads decorators available in the reqstool-python-decorators
package.
$pip install reqstool-python-decorators
pyproject.toml
[tool.poetry.dependencies]
reqstool-python-decorators = "<version>"
Usage
pyproject.toml
Paths
The plugin gets the paths where it will look for decorated code from ("." is filtered out):
[tool.pytest.ini_options]
pythonpath = [".", "src", "tests"]
In this example all files in "src" and "tests", including subfolders, will be processed.
Poetry
This will be added when running poetry add reqstool-python-poetry-plugin
[tool.poetry.dependencies]
reqstool-python-poetry-plugin = "<version>"
Decorators
Used to decorate your code as seen in the examples below, the decorator processing that runs during the build process collects data from the decorated code.
Import decorators:
from reqstool-python-decorators.decorators.decorators import Requirements, SVCs
Example usage of the decorators:
@Requirements("REQ_111", "REQ_222")
def somefunction():
@SVCs("SVC_111", "SVC_222")
def test_somefunction():
Poetry build
When running $poetry build
or $poetry install
the plugin will run the activate
function located inside DecoratorsPlugin
class, calling functions from the reqstool-python-decorators
package and generate a annotations.yml file in the build/reqstool/
folder containing formatted data on all decorated code found.
License
This project is licensed under the MIT License - see the LICENSE.md file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for reqstool_python_poetry_plugin-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8b3f9823ab5199df3f386f98923f1af4c9f227bb390337e12f391ef507ecf39 |
|
MD5 | 6d35e5f98c4dd2243b72c071604a9c36 |
|
BLAKE2b-256 | f184a456f937abc17d339ea5c584ceceebd5e087d240403a176136196dec18e9 |
Hashes for reqstool_python_poetry_plugin-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bfb3ad8edf0a96f13635b345b7e1c4e972e2e2b3584bd9b94669a654f212a0c |
|
MD5 | 513d8f629b517bfd0a1f91b704674f04 |
|
BLAKE2b-256 | 06602c4b29b9df951a58efc2bbf7041cd194790a07625fd05175335910dfa1cd |