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 Networks.

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-2023 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-23.10.4.tar.gz (300.0 kB view details)

Uploaded Source

Built Distribution

pontos-23.10.4-py3-none-any.whl (249.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pontos-23.10.4.tar.gz
  • Upload date:
  • Size: 300.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.13 Linux/6.2.0-1014-azure

File hashes

Hashes for pontos-23.10.4.tar.gz
Algorithm Hash digest
SHA256 f6b69c4f1e07e00f3ac3846aa1e1009e907cf612e6430066df4c0a712b252349
MD5 b1666b632bab85c2cb5c892006468db0
BLAKE2b-256 96cb9653fc1e212ed1beccc551dbf8313baa375e8c793e1ad75666181e823917

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pontos-23.10.4-py3-none-any.whl
  • Upload date:
  • Size: 249.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.13 Linux/6.2.0-1014-azure

File hashes

Hashes for pontos-23.10.4-py3-none-any.whl
Algorithm Hash digest
SHA256 eb8c2383a28003316111382859a726bd00d491c49b04bde74af1b200e4e21ce0
MD5 e191ff7bb971729d4ae5b871bf73f13a
BLAKE2b-256 12ef8f10516398d78e7dfb63d5cc00e3250e5a0fc2bb659526f32f137185c6f4

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