Skip to main content

Common utilities and tools maintained by Greenbone Networks

Project description

Greenbone Logo

Pontos - Greenbone Python Utilities and Tools

GitHub releases PyPI release code test coverage Build and test

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 install command 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

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.

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

pontos-24.2.2.tar.gz (315.7 kB view details)

Uploaded Source

Built Distribution

pontos-24.2.2-py3-none-any.whl (231.6 kB view details)

Uploaded Python 3

File details

Details for the file pontos-24.2.2.tar.gz.

File metadata

  • Download URL: pontos-24.2.2.tar.gz
  • Upload date:
  • Size: 315.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for pontos-24.2.2.tar.gz
Algorithm Hash digest
SHA256 2599ce6adb885cc6f92750d5972cdfa9c6b6eb5fa35485bb429927a60713c2d5
MD5 a30d85734d3c040b71dccc52faaa791b
BLAKE2b-256 aa2ee4de081568c022e30f4bcf245b2b79a6babc787a2ec19c747ee0259afcbe

See more details on using hashes here.

Provenance

File details

Details for the file pontos-24.2.2-py3-none-any.whl.

File metadata

  • Download URL: pontos-24.2.2-py3-none-any.whl
  • Upload date:
  • Size: 231.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for pontos-24.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3e45e17c6627cc32c5fd9ccffb74abba5b324b5da80c564c250dd5386de4aaf0
MD5 a44153efe4ab3b3f5bf1c139dce5dee8
BLAKE2b-256 cb829793e1fb37cbec9c6c4a7aaf97a4cb1b0e41ad8e903425fbc000be2f3e73

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page