# Pontos - Greenbone Python Utilities and Tools <!-- omit in toc -->
[](https://github.com/greenbone/pontos/releases)
[](https://pypi.org/project/pontos/)
[](https://codecov.io/gh/greenbone/pontos)
[](https://github.com/greenbone/pontos/actions/workflows/ci-python.yml)
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](https://en.wikipedia.org/wiki/Pontus_(mythology)),
the titan of the sea.
## Table of Contents <!-- omit in toc -->
- [Documentation](#documentation)
- [Installation](#installation)
- [Requirements](#requirements)
- [Install using pip](#install-using-pip)
- [Install using poetry](#install-using-poetry)
- [Development](#development)
- [Maintainer](#maintainer)
- [Contributing](#contributing)
- [License](#license)
## 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 AG][Greenbone Networks]
## Contributing
Your contributions are highly appreciated. Please
[create a pull request](https://github.com/greenbone/pontos/pulls)
on GitHub. Bigger changes need to be discussed with the development team via the
[issues section at GitHub](https://github.com/greenbone/pontos/issues)
first.
## License
Copyright (C) 2020-2023 [Greenbone AG][Greenbone Networks]
Licensed under the [GNU General Public License v3.0 or later](LICENSE).
[Greenbone Networks]: https://www.greenbone.net/
[poetry]: https://python-poetry.org/
[pip]: https://pip.pypa.io/
[autohooks]: https://github.com/greenbone/autohooks
Raw data
{
"_id": null,
"home_page": "https://github.com/greenbone/pontos/",
"name": "pontos",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/f9/79/25693bec462d83ffb477c2e10a87788071156abb742967cc17d3e3051d08/pontos-23.3.6.tar.gz",
"platform": null,
"description": "\n\n# Pontos - Greenbone Python Utilities and Tools <!-- omit in toc -->\n\n[](https://github.com/greenbone/pontos/releases)\n[](https://pypi.org/project/pontos/)\n[](https://codecov.io/gh/greenbone/pontos)\n[](https://github.com/greenbone/pontos/actions/workflows/ci-python.yml)\n\nThe **pontos** Python package is a collection of utilities, tools, classes and\nfunctions maintained by [Greenbone Networks].\n\nPontos is the German name of the Greek titan [Pontus](https://en.wikipedia.org/wiki/Pontus_(mythology)),\nthe titan of the sea.\n\n## Table of Contents <!-- omit in toc -->\n\n- [Documentation](#documentation)\n- [Installation](#installation)\n - [Requirements](#requirements)\n - [Install using pip](#install-using-pip)\n - [Install using poetry](#install-using-poetry)\n- [Development](#development)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Documentation\n\nThe 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.\n\n## Installation\n\n### Requirements\n\nPython 3.9 and later is supported.\n\n### Install using pip\n\nYou can install the latest stable release of **pontos** from the Python\nPackage Index (pypi) using [pip]\n\n python3 -m pip install --user pontos\n\n### Install using poetry\n\nBecause **pontos** is a Python library you most likely need a tool to\nhandle Python package dependencies and Python environments. Therefore we\nstrongly recommend using [poetry].\n\nYou can install the latest stable release of **pontos** and add it as\na dependency for your current project using [poetry]\n\n poetry add pontos\n\n## Development\n\n**pontos** uses [poetry] for its own dependency management and build\nprocess.\n\nFirst install poetry via pip\n\n python3 -m pip install --user poetry\n\nAfterwards run\n\n poetry install\n\nin the checkout directory of **pontos** (the directory containing the\n`pyproject.toml` file) to install all dependencies including the packages only\nrequired for development.\n\nAfterwards activate the git hooks for auto-formatting and linting via\n[autohooks].\n\n poetry run autohooks activate\n\nValidate the activated git hooks by running\n\n poetry run autohooks check\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG][Greenbone Networks]\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/pontos/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/pontos/issues)\nfirst.\n\n## License\n\nCopyright (C) 2020-2023 [Greenbone AG][Greenbone Networks]\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n\n[Greenbone Networks]: https://www.greenbone.net/\n[poetry]: https://python-poetry.org/\n[pip]: https://pip.pypa.io/\n[autohooks]: https://github.com/greenbone/autohooks\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Common utilities and tools maintained by Greenbone Networks",
"version": "23.3.6",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0470253e9314617cda3c2b4621b86c74b267901a4270e7894bcd71e5012263eb",
"md5": "2cb5f25af13c601e5872ee3ace5a2cee",
"sha256": "05bee283d598392bf9e2b3cf45851863706c376bffe2952c6af7e0f54c39096b"
},
"downloads": -1,
"filename": "pontos-23.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2cb5f25af13c601e5872ee3ace5a2cee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 211435,
"upload_time": "2023-03-22T09:44:03",
"upload_time_iso_8601": "2023-03-22T09:44:03.500314Z",
"url": "https://files.pythonhosted.org/packages/04/70/253e9314617cda3c2b4621b86c74b267901a4270e7894bcd71e5012263eb/pontos-23.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f97925693bec462d83ffb477c2e10a87788071156abb742967cc17d3e3051d08",
"md5": "10d76082d6a2243faa594d0eec3bf506",
"sha256": "efca1b7fe3f819c780dc6d390aef8b37170d0f41d6a808d22d5ff2334cdf38c1"
},
"downloads": -1,
"filename": "pontos-23.3.6.tar.gz",
"has_sig": false,
"md5_digest": "10d76082d6a2243faa594d0eec3bf506",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 241328,
"upload_time": "2023-03-22T09:44:05",
"upload_time_iso_8601": "2023-03-22T09:44:05.164227Z",
"url": "https://files.pythonhosted.org/packages/f9/79/25693bec462d83ffb477c2e10a87788071156abb742967cc17d3e3051d08/pontos-23.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-22 09:44:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "greenbone",
"github_project": "pontos",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pontos"
}
JSON
