The pontos Python package is a collection of utilities, tools, classes and functions maintained by Greenbone.
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 pipx
python3 -m pipx install pontos
[!NOTE] The
pip installcommand does no longer work out-of-the-box in newer distributions like Ubuntu 23.04 because of PEP 668. Please use the installation via pipx instead.
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 comes with support for command line completion in bash and zsh. All
pontos CLI commands support shell completion. As examples the following sections
explain how to set up the completion for pontos-release with bash and zsh.
echo "source ~/.pontos-release-complete.bash" >> ~/.bashrc
pontos-release --print-completion bash > ~/.pontos-release-complete.bash
Alternatively, you can use the result of the completion command directly with the eval function of your bash shell:
eval "$(pontos-release --print-completion bash)"
echo 'fpath=("$HOME/.zsh.d" $fpath)' >> ~/.zsh
mkdir -p ~/.zsh.d/
pontos-release --print-completion zsh > ~/.zsh.d/_pontos_release
Alternatively, you can use the result of the completion command directly with the eval function of your zsh shell:
eval "$(pontos-release --print-completion zsh)"
pontos 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 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-2024 Greenbone AG
Licensed under the GNU General Public License v3.0 or later.
FAQs
Common utilities and tools maintained by Greenbone Networks
We found that pontos demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.