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 pip

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 pip

python3 -m pip install --user 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 Networks GmbH

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

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

Uploaded Source

Built Distribution

pontos-23.2.0-py3-none-any.whl (184.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pontos-23.2.0.tar.gz
  • Upload date:
  • Size: 223.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for pontos-23.2.0.tar.gz
Algorithm Hash digest
SHA256 ff38b5f33f100c736e84b5fccdf3371ae34528e64533deb1adcba6ad0033b4f0
MD5 a45890757655625f2723fd39481e1c21
BLAKE2b-256 07111ffa939f69452bfa7daa38aa26bc9fb417a9b1a3f52cb35899a64c626538

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pontos-23.2.0-py3-none-any.whl
  • Upload date:
  • Size: 184.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for pontos-23.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4e991d613f27d8646a70f41e45595bbf4a559720559e545378e91e59bfdf6bbc
MD5 8e4652349b917a7ba731f1b385eeb5b3
BLAKE2b-256 a8634a1fb3da4edb8cffdfcb59b8b13f0004535d6461c3cd33be96ae5e6e70a0

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