The pontos Python package is a collection of utilities, tools, classes and functions maintained by Greenbone Networks.
Pontos is the German name of the Greek titan Pontus, the titan of the sea.
The documentation for pontos can be found at https://greenbone.github.io/pontos/. Please refer to the documentation for more details as this README just gives a short overview.
Python 3.9 and later is supported.
You can install the latest stable release of pontos from the Python Package Index (pypi) using pip
python3 -m pip install --user pontos
Because pontos is a Python library you most likely need a tool to handle Python package dependencies and Python environments. Therefore we strongly recommend using poetry.
You can install the latest stable release of pontos and add it as a dependency for your current project using poetry
poetry add pontos
pontos uses poetry for its own dependency management and build process.
First install poetry via pip
python3 -m pip install --user poetry
Afterwards run
poetry install
in the checkout directory of pontos (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
This project is maintained by Greenbone AG
Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.
Copyright (C) 2020-2023 Greenbone AG
Licensed under the GNU General Public License v3.0 or later.