python-gvm 26.11.1__tar.gz → 27.0.1__tar.gz

python_gvm-27.0.1/.gitignore

@@ -0,0 +1,18 @@
+__pycache__
+*.pyc
+*.log
+.egg
+*.egg-info
+dist
+build
+_build
+.idea
+.vscode
+htmlcov
+.coverage
+.venv
+.rej
+.DS_Store
+
+# ruff
+.ruff_cache/

python_gvm-27.0.1/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: python-gvm
+Version: 27.0.1
+Summary: Library to communicate with remote servers over GMP or OSP
+Project-URL: Homepage, https://github.com/greenbone/python-gvm/
+Project-URL: Repository, https://github.com/greenbone/python-gvm/
+Project-URL: Documentation, https://greenbone.github.io/python-gvm/
+Author-email: Greenbone AG <info@greenbone.net>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4,>=3.10
+Requires-Dist: httpx[http2]<0.29,>=0.28.1
+Requires-Dist: lxml>=4.5.0
+Requires-Dist: paramiko>=2.7.1
+Description-Content-Type: text/markdown
+
+![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)
+
+# Greenbone Vulnerability Management Python Library <!-- omit in toc -->
+
+[![GitHub releases](https://img.shields.io/github/release-pre/greenbone/python-gvm.svg)](https://github.com/greenbone/python-gvm/releases)
+[![PyPI release](https://img.shields.io/pypi/v/python-gvm.svg)](https://pypi.org/project/python-gvm/)
+[![code test coverage](https://codecov.io/gh/greenbone/python-gvm/branch/main/graph/badge.svg)](https://codecov.io/gh/greenbone/python-gvm)
+[![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)
+
+The Greenbone Vulnerability Management Python API library (**python-gvm**) is a
+collection of APIs that help with remote controlling Greenbone Community Edition
+installations and Greenbone Enterprise Appliances. The library essentially
+abstracts accessing the communication protocols Greenbone Management Protocol
+(GMP) and Open Scanner Protocol (OSP).
+
+## Table of Contents <!-- omit in toc -->
+
+- [Documentation](#documentation)
+- [Installation](#installation)
+  - [Version](#version)
+  - [Requirements](#requirements)
+  - [Install using pip](#install-using-pip)
+- [Example](#example)
+- [Support](#support)
+- [Maintainer](#maintainer)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Documentation
+
+The documentation for python-gvm can be found at
+[https://greenbone.github.io/python-gvm/](https://greenbone.github.io/python-gvm/).
+Please always take a look at the documentation for further details. This
+**README** just gives you a short overview.
+
+## Installation
+
+### Version
+
+`python-gvm` uses [semantic versioning](https://semver.org/).
+
+Versions prior to 26.0.0 used [calendar versioning](https://calver.org/).
+
+Please consider to always use the **newest** releases of `gvm-tools` and `python-gvm`.
+We frequently update these projects to add features and keep them free from bugs.
+
+> [!IMPORTANT]
+> To use `python-gvm` with GMP version of 7, 8 or 9 you must use a release version
+> that is `<21.5`. In the `21.5` release the support of these versions has been
+> dropped.
+
+> [!IMPORTANT]
+> To use `python-gvm` with  GMP version 20.8 or 21.4 you must use a release version
+> that is `<24.6`. In the `24.6` release the support of these versions has been
+> dropped.
+
+### Requirements
+
+Python 3.10 and later is supported.
+
+### Install using pip
+
+You can install the latest stable release of python-gvm from the Python Package
+Index using [pip](https://pip.pypa.io/):
+
+```shell
+python3 -m pip install --user python-gvm
+```
+
+## Example
+
+```python3
+from gvm.connections import UnixSocketConnection
+from gvm.protocols.gmp import GMP
+from gvm.transforms import EtreeTransform
+from gvm.xml import pretty_print
+
+connection = UnixSocketConnection()
+transform = EtreeTransform()
+
+with GMP(connection, transform=transform) as gmp:
+    # Retrieve GMP version supported by the remote daemon
+    version = gmp.get_version()
+
+    # Prints the XML in beautiful form
+    pretty_print(version)
+
+    # Login
+    gmp.authenticate('foo', 'bar')
+
+    # Retrieve all tasks
+    tasks = gmp.get_tasks()
+
+    # Get names of tasks
+    task_names = tasks.xpath('task/name/text()')
+    pretty_print(task_names)
+```
+
+## Support
+
+For any question on the usage of python-gvm please use the
+[Greenbone Community Forum](https://forum.greenbone.net/c/building-from-source-under-the-hood/gmp/11). If you
+found a problem with the software, please
+[create an issue](https://github.com/greenbone/python-gvm/issues)
+on GitHub.
+
+## Maintainer
+
+This project is maintained by [Greenbone AG](https://www.greenbone.net/).
+
+## Contributing
+
+Your contributions are highly appreciated. Please
+[create a pull request](https://github.com/greenbone/python-gvm/pulls) on GitHub.
+For bigger changes, please discuss it first in the
+[issues](https://github.com/greenbone/python-gvm/issues).
+
+For development you should use [uv].
+to keep you python packages separated in different environments. First install
+uv via pip
+
+```shell
+python3 -m pip install --user uv
+```
+
+The python-gvm repository uses [autohooks](https://github.com/greenbone/autohooks)
+to apply linting and auto formatting via git hooks. Please ensure the git hooks
+are active.
+
+```shell
+uv run autohooks activate --force
+```
+
+## License
+
+Copyright (C) 2017-2026 [Greenbone AG](https://www.greenbone.net/)
+
+Licensed under the [GNU General Public License v3.0 or later](LICENSE).
+
+[uv]: https://docs.astral.sh/uv/

python_gvm-27.0.1/README.md

@@ -0,0 +1,140 @@
+![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)
+
+# Greenbone Vulnerability Management Python Library <!-- omit in toc -->
+
+[![GitHub releases](https://img.shields.io/github/release-pre/greenbone/python-gvm.svg)](https://github.com/greenbone/python-gvm/releases)
+[![PyPI release](https://img.shields.io/pypi/v/python-gvm.svg)](https://pypi.org/project/python-gvm/)
+[![code test coverage](https://codecov.io/gh/greenbone/python-gvm/branch/main/graph/badge.svg)](https://codecov.io/gh/greenbone/python-gvm)
+[![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)
+
+The Greenbone Vulnerability Management Python API library (**python-gvm**) is a
+collection of APIs that help with remote controlling Greenbone Community Edition
+installations and Greenbone Enterprise Appliances. The library essentially
+abstracts accessing the communication protocols Greenbone Management Protocol
+(GMP) and Open Scanner Protocol (OSP).
+
+## Table of Contents <!-- omit in toc -->
+
+- [Documentation](#documentation)
+- [Installation](#installation)
+  - [Version](#version)
+  - [Requirements](#requirements)
+  - [Install using pip](#install-using-pip)
+- [Example](#example)
+- [Support](#support)
+- [Maintainer](#maintainer)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Documentation
+
+The documentation for python-gvm can be found at
+[https://greenbone.github.io/python-gvm/](https://greenbone.github.io/python-gvm/).
+Please always take a look at the documentation for further details. This
+**README** just gives you a short overview.
+
+## Installation
+
+### Version
+
+`python-gvm` uses [semantic versioning](https://semver.org/).
+
+Versions prior to 26.0.0 used [calendar versioning](https://calver.org/).
+
+Please consider to always use the **newest** releases of `gvm-tools` and `python-gvm`.
+We frequently update these projects to add features and keep them free from bugs.
+
+> [!IMPORTANT]
+> To use `python-gvm` with GMP version of 7, 8 or 9 you must use a release version
+> that is `<21.5`. In the `21.5` release the support of these versions has been
+> dropped.
+
+> [!IMPORTANT]
+> To use `python-gvm` with  GMP version 20.8 or 21.4 you must use a release version
+> that is `<24.6`. In the `24.6` release the support of these versions has been
+> dropped.
+
+### Requirements
+
+Python 3.10 and later is supported.
+
+### Install using pip
+
+You can install the latest stable release of python-gvm from the Python Package
+Index using [pip](https://pip.pypa.io/):
+
+```shell
+python3 -m pip install --user python-gvm
+```
+
+## Example
+
+```python3
+from gvm.connections import UnixSocketConnection
+from gvm.protocols.gmp import GMP
+from gvm.transforms import EtreeTransform
+from gvm.xml import pretty_print
+
+connection = UnixSocketConnection()
+transform = EtreeTransform()
+
+with GMP(connection, transform=transform) as gmp:
+    # Retrieve GMP version supported by the remote daemon
+    version = gmp.get_version()
+
+    # Prints the XML in beautiful form
+    pretty_print(version)
+
+    # Login
+    gmp.authenticate('foo', 'bar')
+
+    # Retrieve all tasks
+    tasks = gmp.get_tasks()
+
+    # Get names of tasks
+    task_names = tasks.xpath('task/name/text()')
+    pretty_print(task_names)
+```
+
+## Support
+
+For any question on the usage of python-gvm please use the
+[Greenbone Community Forum](https://forum.greenbone.net/c/building-from-source-under-the-hood/gmp/11). If you
+found a problem with the software, please
+[create an issue](https://github.com/greenbone/python-gvm/issues)
+on GitHub.
+
+## Maintainer
+
+This project is maintained by [Greenbone AG](https://www.greenbone.net/).
+
+## Contributing
+
+Your contributions are highly appreciated. Please
+[create a pull request](https://github.com/greenbone/python-gvm/pulls) on GitHub.
+For bigger changes, please discuss it first in the
+[issues](https://github.com/greenbone/python-gvm/issues).
+
+For development you should use [uv].
+to keep you python packages separated in different environments. First install
+uv via pip
+
+```shell
+python3 -m pip install --user uv
+```
+
+The python-gvm repository uses [autohooks](https://github.com/greenbone/autohooks)
+to apply linting and auto formatting via git hooks. Please ensure the git hooks
+are active.
+
+```shell
+uv run autohooks activate --force
+```
+
+## License
+
+Copyright (C) 2017-2026 [Greenbone AG](https://www.greenbone.net/)
+
+Licensed under the [GNU General Public License v3.0 or later](LICENSE).
+
+[uv]: https://docs.astral.sh/uv/

python_gvm-27.0.1/docs/Makefile

@@ -0,0 +1,22 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -W # treat warnings as errors
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile livehtml
+
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

python_gvm-27.0.1/docs/_static/custom.css

@@ -0,0 +1,252 @@
+div.document {
+	width: 1200px;
+}
+
+body {
+	font-family: Helvetica, Verdana;
+}
+
+div.body {
+	max-width: 1200px;
+}
+
+h1, h2, h3, h4, h5, h6 {
+font-weight:500;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+    font-family: Helvetica, Verdana;
+ }
+
+.sphinx-tabs-tab {
+	color:var(--color-content-foreground);
+	font-family: Helvetica, Verdana;
+}
+
+a {
+    color: var(--color-content-foreground);
+    text-decoration: none;
+    border-bottom: 1px dotted var(--color-content-foreground);
+}
+
+a:hover {
+	color: #11AB51;
+	border-bottom: 1px solid var(--color-content-foreground);
+}
+
+.related-pages a .page-info .title, .bottom-of-page a {
+	color: var(--color-foreground-secondary);
+    text-decoration: none;
+	border-bottom: 1px dotted var(--color-foreground-secondary);
+}
+
+.related-pages a:hover .page-info .title, .bottom-of-page a:hover {
+    text-decoration: none;
+	color: #11AB51;
+	border-bottom: 1px solid var(--color-foreground-secondary);
+}
+
+a.muted-link  {
+	border-bottom:0;
+}
+
+a.muted-link:hover {
+	border-bottom:0;
+	color:#11AB51;
+}
+
+a.sidebar-brand, .toctree-l1 > a.reference, .toc-tree a.reference {
+	border-bottom: 0;
+}
+
+.toctree-l1 > a.reference:hover, .toc-tree a.reference:hover {
+	border-bottom: 0;
+	color: #11AB51;
+}
+
+.related-pages a {
+	border-bottom:0;
+}
+
+.related-pages a:hover {
+	border-bottom:0;
+}
+
+.toctree-wrapper .caption-text, .sidebar-tree .caption-text {
+	font-size:2em;
+	font-weight:500;
+	color: var(--color-content-foreground);
+}
+
+.sidebar-brand-text {
+	text-align:left;
+}
+
+.sidebar-search {
+	color:var(--color-content-foreground);
+}
+
+.sidebar-tree .toctree-l1 > .reference {
+	color: var(--color-content-foreground);
+}
+
+.toc-tree li.scroll-current > .reference {
+	color: var(--color-content-foreground);
+}
+
+.toc-tree .reference {
+	color: var(--color-content-foreground);
+	font-size:1.1em;
+}
+
+.toc-title {
+	color: var(--color-content-foreground);
+	font-size:1.2em;
+}
+
+div.admonition {
+	background-color:var(--color-background-secondary);
+    padding: 20px 20px;
+    border-radius: 4px;
+}
+
+.admonition.note > .admonition-title, .admonition.warning > .admonition-title, .admonition.tip > .admonition-title, .admonition.important > .admonition-title, .admonition.hint > .admonition-title {
+	background-color:var(--color-background-secondary);
+    font-family: Helvetica, Verdana;
+    font-weight: bold;
+    font-size:1em;
+}
+
+div.body p.caption {
+	font-size: 240%;
+	margin-bottom: 0px;
+}
+
+div.sphinxsidebar h3 {
+    font-family: Helvetica, Verdana;
+}
+
+div.sphinxsidebar a {
+    border: 0px;
+}
+
+div.sphinxsidebarwrapper p.description {
+  font-size: 15px;
+}
+
+div.sphinxsidebarwrapper h1.logo {
+  font-size: 25px;
+}
+
+div.sphinxsidebarwrapper h1.logo-name {
+	margin-top:50px;
+}
+
+div.sphinxsidebarwrapper p.description {
+	margin-bottom: 50px;
+}
+
+
+div.sphinxsidebarwrapper img {
+  max-width: 70%;
+}
+
+.highlight-shell-session .go::before {
+  content: ">";
+  padding-right: 1em;
+}
+
+.highlight pre {
+  border-radius: 6px;
+  font-family: Consolas,Monaco,Andale Mono,Ubuntu Mono,monospace;
+  font-size: 0.9em;
+  line-height: 1.2;
+  padding: 1.25rem 1.5rem;
+}
+
+.code-block-caption {
+	font-size:0.7em;
+	background-color: var(--color-background-secondary);
+	color: var(--color-foreground-primary);
+}
+
+
+.code-block-caption a {
+	color:var(--color-foreground-primary);
+}
+
+.code-block-caption a:hover {
+	color:#11AB51;
+}
+
+
+div.edit-this-page > a.muted-link, svg.icon-tabler-shadow, svg.theme-icon-when-dark, svg.theme-icon-when-light {
+	color:var(--color-content-foreground);
+}
+
+
+div.edit-this-page > a.muted-link:hover, svg.icon.icon-tabler.icon-tabler-copy:hover, svg.icon-tabler-shadow:hover, svg.theme-icon-when-dark:hover, svg.theme-icon-when-light:hover {
+	color:#11AB51;
+}
+
+.highlight {
+	background-color: var(--color-code-background);
+	color:var(--color-code-foreground);
+}
+
+.highlight button.copybtn {
+	background-color:transparent;
+}
+
+.highlight button.copybtn:hover {
+	background-color:transparent;
+}
+
+
+svg.icon.icon-tabler.icon-tabler-copy {
+	color: var(--color-code-foreground);
+
+}
+
+.highlight .go {
+	color: var(--color-code-foreground);
+	font-weight: normal;
+}
+
+.highlight .l {
+	color: var(--color-code-foreground);
+}
+
+#contents.toc {
+    background-color: #ffffff;
+    border: none;
+}
+
+.back-to-top {
+	background-color:var(--color-background-secondary);
+}
+
+div.topic {
+	border-radius: 4px;
+}
+
+div.topic a.reference.internal {
+	border: 0px;
+}
+
+div.toctree-wrapper.compound a.reference.internal {
+	border: 0px;
+}
+
+#indices-and-tables a.reference.internal {
+	border: 0px;
+}
+
+.sidebar-logo {
+  max-width: 70%;
+}