{"id":18565040,"url":"https://github.com/greenbone/python-gvm","last_synced_at":"2025-05-15T04:03:39.617Z","repository":{"id":37385101,"uuid":"155835839","full_name":"greenbone/python-gvm","owner":"greenbone","description":"Greenbone Vulnerability Management Python Library","archived":false,"fork":false,"pushed_at":"2025-04-11T10:05:09.000Z","size":6721,"stargazers_count":114,"open_issues_count":9,"forks_count":62,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-04-11T11:51:47.904Z","etag":null,"topics":["extended","gea","gmp","greenbone","greenbone-vulnerability-manager","gvm","osp","python","python-library","tooling","vulnerability-detection","vulnerability-management","vulnerability-scanners"],"latest_commit_sha":null,"homepage":"https://greenbone.github.io/python-gvm/","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}},"created_at":"2018-11-02T08:24:17.000Z","updated_at":"2025-04-07T06:19:32.000Z","dependencies_parsed_at":"2023-09-25T07:13:44.047Z","dependency_job_id":"de337af0-5474-4b0a-8175-db524c143e01","html_url":"https://github.com/greenbone/python-gvm","commit_stats":{"total_commits":2406,"total_committers":37,"mean_commits":65.02702702702703,"dds":0.6438071487946799,"last_synced_commit":"e57a46cf059ecdb737e9cd6b8f1a391d1eb13db3"},"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fpython-gvm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fpython-gvm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fpython-gvm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fpython-gvm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greenbone","download_url":"https://codeload.github.com/greenbone/python-gvm/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625466,"owners_count":21135512,"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":["extended","gea","gmp","greenbone","greenbone-vulnerability-manager","gvm","osp","python","python-library","tooling","vulnerability-detection","vulnerability-management","vulnerability-scanners"],"created_at":"2024-11-06T22:17:27.073Z","updated_at":"2025-04-12T19:43:14.928Z","avatar_url":"https://github.com/greenbone.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)\n\n# Greenbone Vulnerability Management Python Library \u003c!-- omit in toc --\u003e\n\n[![GitHub releases](https://img.shields.io/github/release-pre/greenbone/python-gvm.svg)](https://github.com/greenbone/python-gvm/releases)\n[![PyPI release](https://img.shields.io/pypi/v/python-gvm.svg)](https://pypi.org/project/python-gvm/)\n[![code test coverage](https://codecov.io/gh/greenbone/python-gvm/branch/main/graph/badge.svg)](https://codecov.io/gh/greenbone/python-gvm)\n[![Build and test](https://github.com/greenbone/python-gvm/actions/workflows/ci.yml/badge.svg)](https://github.com/greenbone/python-gvm/actions/workflows/ci.yml)\n\nThe Greenbone Vulnerability Management Python API library (**python-gvm**) is a\ncollection of APIs that help with remote controlling Greenbone Community Edition\ninstallations and Greenbone Enterprise Appliances. The library essentially\nabstracts accessing the communication protocols Greenbone Management Protocol\n(GMP) and Open Scanner Protocol (OSP).\n\n## Table of Contents \u003c!-- omit in toc --\u003e\n\n- [Documentation](#documentation)\n- [Installation](#installation)\n  - [Version](#version)\n  - [Requirements](#requirements)\n  - [Install using pip](#install-using-pip)\n- [Example](#example)\n- [Support](#support)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Documentation\n\nThe documentation for python-gvm can be found at\n[https://greenbone.github.io/python-gvm/](https://greenbone.github.io/python-gvm/).\nPlease always take a look at the documentation for further details. This\n**README** just gives you a short overview.\n\n## Installation\n\n### Version\n\n`python-gvm` uses [semantic versioning](https://semver.org/).\n\nVersions prior to 26.0.0 used [calendar versioning](https://calver.org/).\n\nPlease consider to always use the **newest** releases of `gvm-tools` and `python-gvm`.\nWe frequently update these projects to add features and keep them free from bugs.\n\n\u003e [!IMPORTANT]\n\u003e To use `python-gvm` with GMP version of 7, 8 or 9 you must use a release version\n\u003e that is `\u003c21.5`. In the `21.5` release the support of these versions has been\n\u003e dropped.\n\n\u003e [!IMPORTANT]\n\u003e To use `python-gvm` with  GMP version 20.8 or 21.4 you must use a release version\n\u003e that is `\u003c24.6`. In the `24.6` release the support of these versions has been\n\u003e dropped.\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 python-gvm from the Python Package\nIndex using [pip](https://pip.pypa.io/):\n\n```shell\npython3 -m pip install --user python-gvm\n```\n\n## Example\n\n```python3\nfrom gvm.connections import UnixSocketConnection\nfrom gvm.protocols.gmp import GMP\nfrom gvm.transforms import EtreeTransform\nfrom gvm.xml import pretty_print\n\nconnection = UnixSocketConnection()\ntransform = EtreeTransform()\n\nwith GMP(connection, transform=transform) as gmp:\n    # Retrieve GMP version supported by the remote daemon\n    version = gmp.get_version()\n\n    # Prints the XML in beautiful form\n    pretty_print(version)\n\n    # Login\n    gmp.authenticate('foo', 'bar')\n\n    # Retrieve all tasks\n    tasks = gmp.get_tasks()\n\n    # Get names of tasks\n    task_names = tasks.xpath('task/name/text()')\n    pretty_print(task_names)\n```\n\n## Support\n\nFor any question on the usage of python-gvm please use the\n[Greenbone Community Forum](https://forum.greenbone.net/c/building-from-source-under-the-hood/gmp/11). If you\nfound a problem with the software, please\n[create an issue](https://github.com/greenbone/python-gvm/issues)\non GitHub.\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/python-gvm/pulls) on GitHub.\nFor bigger changes, please discuss it first in the\n[issues](https://github.com/greenbone/python-gvm/issues).\n\nFor development you should use [poetry](https://python-poetry.org)\nto keep you python packages separated in different environments. First install\npoetry via pip\n\n```shell\npython3 -m pip install --user poetry\n```\n\nAfterwards run\n\n```shell\npoetry install\n```\n\nin the checkout directory of python-gvm (the directory containing the\n`pyproject.toml` file) to install all dependencies including the packages only\nrequired for development.\n\nThe python-gvm repository uses [autohooks](https://github.com/greenbone/autohooks)\nto apply linting and auto formatting via git hooks. Please ensure the git hooks\nare active.\n\n```shell\npoetry install\npoetry run autohooks activate --force\n```\n\n## License\n\nCopyright (C) 2017-2025 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fpython-gvm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreenbone%2Fpython-gvm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fpython-gvm/lists"}