{"id":18565039,"url":"https://github.com/greenbone/pontos","last_synced_at":"2025-04-10T01:15:53.714Z","repository":{"id":36977657,"uuid":"254081506","full_name":"greenbone/pontos","owner":"greenbone","description":"Common utilities and tools maintained by Greenbone Networks","archived":false,"fork":false,"pushed_at":"2025-04-07T06:51:02.000Z","size":5095,"stargazers_count":9,"open_issues_count":1,"forks_count":12,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-04-10T01:15:06.059Z","etag":null,"topics":["base","changelog","devops","git","github","library","pypi","python","release","release-automation","release-notes","tooling"],"latest_commit_sha":null,"homepage":"https://greenbone.github.io/pontos/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greenbone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-08T12:28:39.000Z","updated_at":"2025-04-07T06:51:05.000Z","dependencies_parsed_at":"2023-10-12T21:18:04.976Z","dependency_job_id":"bc2b17ee-b0aa-45cc-9046-e1c8c329a9a3","html_url":"https://github.com/greenbone/pontos","commit_stats":{"total_commits":1589,"total_committers":17,"mean_commits":93.47058823529412,"dds":0.6230333543108874,"last_synced_commit":"6f9305541e9a6a6fb003ce37e59e9ab48aaffbfd"},"previous_names":[],"tags_count":145,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fpontos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fpontos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fpontos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fpontos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greenbone","download_url":"https://codeload.github.com/greenbone/pontos/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137891,"owners_count":21053775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["base","changelog","devops","git","github","library","pypi","python","release","release-automation","release-notes","tooling"],"created_at":"2024-11-06T22:17:26.892Z","updated_at":"2025-04-10T01:15:53.697Z","avatar_url":"https://github.com/greenbone.png","language":"Python","readme":"![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)\n\n# Pontos - Greenbone Python Utilities and Tools \u003c!-- omit in toc --\u003e\n\n[![GitHub releases](https://img.shields.io/github/release/greenbone/pontos.svg)](https://github.com/greenbone/pontos/releases)\n[![PyPI release](https://img.shields.io/pypi/v/pontos.svg)](https://pypi.org/project/pontos/)\n[![code test coverage](https://codecov.io/gh/greenbone/pontos/branch/main/graph/badge.svg)](https://codecov.io/gh/greenbone/pontos)\n[![Build and test](https://github.com/greenbone/pontos/actions/workflows/ci-python.yml/badge.svg)](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].\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 \u003c!-- omit in toc --\u003e\n\n- [Documentation](#documentation)\n- [Installation](#installation)\n  - [Requirements](#requirements)\n  - [Install using pipx](#install-using-pipx)\n  - [Install using pip](#install-using-pip)\n  - [Install using poetry](#install-using-poetry)\n- [Command Completion](#command-completion)\n  - [Setup for bash](#setup-for-bash)\n  - [Setup for zsh](#setup-for-zsh)\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 pipx\n\nYou can install the latest stable release of **pontos** from the Python\nPackage Index (pypi) using [pipx]\n\n    python3 -m pipx install pontos\n\n### Install using pip\n\n\u003e [!NOTE]\n\u003e The `pip install` command does no longer work out-of-the-box in newer\n\u003e distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668).\n\u003e Please use the [installation via pipx](#install-using-pipx) instead.\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## Command Completion\n\n`pontos` comes with support for command line completion in bash and zsh. All\npontos CLI commands support shell completion. As examples the following sections\nexplain how to set up the completion for `pontos-release` with bash and zsh.\n\n### Setup for bash\n\n```bash\necho \"source ~/.pontos-release-complete.bash\" \u003e\u003e ~/.bashrc\npontos-release --print-completion bash \u003e ~/.pontos-release-complete.bash\n```\n\nAlternatively, you can use the result of the completion command directly with\nthe eval function of your bash shell:\n\n```bash\neval \"$(pontos-release --print-completion bash)\"\n```\n\n### Setup for zsh\n\n```zsh\necho 'fpath=(\"$HOME/.zsh.d\" $fpath)' \u003e\u003e ~/.zsh\nmkdir -p ~/.zsh.d/\npontos-release --print-completion zsh \u003e ~/.zsh.d/_pontos_release\n```\n\nAlternatively, you can use the result of the completion command directly with\nthe eval function of your zsh shell:\n\n```bash\neval \"$(pontos-release --print-completion zsh)\"\n```\n\n\n## Development\n\n**pontos** uses [poetry] for its own dependency management and build\nprocess.\n\nFirst install poetry via [pipx]\n\n    python3 -m pipx install 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]\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-2024 [Greenbone AG][Greenbone]\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n\n[Greenbone]: https://www.greenbone.net/\n[poetry]: https://python-poetry.org/\n[pip]: https://pip.pypa.io/\n[pipx]: https://pypa.github.io/pipx/\n[autohooks]: https://github.com/greenbone/autohooks\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fpontos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreenbone%2Fpontos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fpontos/lists"}