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.7.1.tar.gz (258.6 kB view details)

Uploaded Source

Built Distribution

pontos-23.7.1-py3-none-any.whl (224.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pontos-23.7.1.tar.gz
  • Upload date:
  • Size: 258.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.12 Linux/5.15.0-1040-azure

File hashes

Hashes for pontos-23.7.1.tar.gz
Algorithm Hash digest
SHA256 01fb5c273d6139e8c80477f9bfabd8503c3f6f49a43cb705d7e1205ea6f9372a
MD5 be09b64d63b6094c94e0c3e1511259c7
BLAKE2b-256 3206b5ce523edb88dbd0ffbe864f7b9a824c68c780ee6232d11da768a46974ef

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pontos-23.7.1-py3-none-any.whl
  • Upload date:
  • Size: 224.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.12 Linux/5.15.0-1040-azure

File hashes

Hashes for pontos-23.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed6787684a2739f9864f49bc2573e8b5cb1500e302b07150f9fa239b6b6c2f43
MD5 01e7f8eeb9d43830acba1c682edd2f97
BLAKE2b-256 425f563833147c0cdd08917bc80219e493415f61aff407c175f517560d9dcc84

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