python-project-template

Python Project Template

Table of Contents

• Requirements
• Development
• Maintainer
• License

Requirements

Python 3.9 and later is supported.

Development

example uses poetry for its own dependency management and build process.

First install poetry via pipx

python3 -m pipx install poetry

Afterwards run

poetry install

in the checkout directory of example (the directory containing the pyproject.toml file) to install all dependencies including the packages only required for development.

Afterwards activate the git hooks for auto-formatting and linting via autohooks.

poetry run autohooks activate

Validate the activated git hooks by running

poetry run autohooks check

Maintainer

This project is maintained by Greenbone AG

License

Copyright (C) 2024 Greenbone AG

Licensed under the GNU Affero General Public License v3.0 or later.