Common utilities and tools maintained by Greenbone Networks
Project description
Pontos - Greenbone Python Utilities and Tools
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.
Table of Contents
Documentation
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.
Installation
Requirements
Python 3.9 and later is supported.
Install using pipx
You can install the latest stable release of pontos from the Python Package Index (pypi) using pipx
python3 -m pipx install pontos
Install using pip
[!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
Install using poetry
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
Command Completion
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.
Setup for bash
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)"
Setup for zsh
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)"
Development
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
Maintainer
This project is maintained by Greenbone AG
Contributing
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.
License
Copyright (C) 2020-2024 Greenbone AG
Licensed under the GNU General Public License v3.0 or later.
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
File details
Details for the file pontos-24.3.0.tar.gz.
File metadata
- Download URL: pontos-24.3.0.tar.gz
- Upload date:
- Size: 316.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1566c4fba3b4c7e1618906539727079a6c693c08c22d3e39dae5599d956d17f4 |
|
| MD5 | e3a69ec31c7311129fb21781f9231f63 |
|
| BLAKE2b-256 | a978d62eed9ee8684eea3f1c0d0eb1f49edcc3ab4cf76798d7539fc6e205093d |
Provenance
File details
Details for the file pontos-24.3.0-py3-none-any.whl.
File metadata
- Download URL: pontos-24.3.0-py3-none-any.whl
- Upload date:
- Size: 231.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 006511ee5eea4df21d91181a64bc6c659630c060e9a9a275d4c3c6042092b566 |
|
| MD5 | 54e8cf49f900f858e54f71997c04d4e7 |
|
| BLAKE2b-256 | c6e32d31c8402f7d883587fd9d0adbd4413866b6a1b339bd48a3fc8407377bdc |
