python-gvm 23.12.0__tar.gz → 24.3.0__tar.gz

python_gvm-24.3.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.1
+Name: python-gvm
+Version: 24.3.0
+Summary: Library to communicate with remote servers over GMP or OSP
+Home-page: https://github.com/greenbone/python-gvm/
+License: GPL-3.0-or-later
+Author: Greenbone AG
+Author-email: info@greenbone.net
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: defusedxml (>=0.6)
+Requires-Dist: lxml (>=4.5.0)
+Requires-Dist: paramiko (>=2.7.1)
+Requires-Dist: typing-extensions (>=4.9.0)
+Project-URL: Documentation, https://greenbone.github.io/python-gvm/
+Project-URL: Repository, https://github.com/greenbone/python-gvm/
+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
+
+Please consider to always use the **newest** version of `gvm-tools` and `python-gvm`.
+We frequently update this projects to add features and keep them free from bugs.
+This is why installing `python-gvm` using pip is recommended.
+
+**To use `python-gvm` with an old GMP version (7, 8, 9) you must use a release version**
+**that is `<21.05`. In the `21.05` release the support of these versions have been dropped.**
+
+### Requirements
+
+Python 3.9 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/):
+
+    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 [poetry](https://python-poetry.org)
+to keep you python packages separated in different environments. First install
+poetry via pip
+
+```shell
+python3 -m pip install --user poetry
+```
+
+Afterwards run
+
+```shell
+poetry install
+```
+
+in the checkout directory of python-gvm (the directory containing the
+`pyproject.toml` file) to install all dependencies including the packages only
+required for development.
+
+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.
+
+    $ poetry install
+    $ poetry run autohooks activate --force
+
+## License
+
+Copyright (C) 2017-2024 [Greenbone AG](https://www.greenbone.net/)
+
+Licensed under the [GNU General Public License v3.0 or later](LICENSE).
+

python_gvm-24.3.0/README.md

@@ -0,0 +1,135 @@
+![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
+
+Please consider to always use the **newest** version of `gvm-tools` and `python-gvm`.
+We frequently update this projects to add features and keep them free from bugs.
+This is why installing `python-gvm` using pip is recommended.
+
+**To use `python-gvm` with an old GMP version (7, 8, 9) you must use a release version**
+**that is `<21.05`. In the `21.05` release the support of these versions have been dropped.**
+
+### Requirements
+
+Python 3.9 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/):
+
+    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 [poetry](https://python-poetry.org)
+to keep you python packages separated in different environments. First install
+poetry via pip
+
+```shell
+python3 -m pip install --user poetry
+```
+
+Afterwards run
+
+```shell
+poetry install
+```
+
+in the checkout directory of python-gvm (the directory containing the
+`pyproject.toml` file) to install all dependencies including the packages only
+required for development.
+
+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.
+
+    $ poetry install
+    $ poetry run autohooks activate --force
+
+## License
+
+Copyright (C) 2017-2024 [Greenbone AG](https://www.greenbone.net/)
+
+Licensed under the [GNU General Public License v3.0 or later](LICENSE).

python_gvm-24.3.0/gvm/__init__.py

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+"""
+Main module of python-gvm.
+"""
+from .__version__ import __version__
+
+
+def get_version() -> str:
+    """Returns the version of python-gvm as a string in `PEP440`_ compliant
+    format.
+
+    Returns:
+        Current version of python-gvm
+
+    .. _PEP440:
+       https://www.python.org/dev/peps/pep-0440
+    """
+    return __version__

python_gvm-24.3.0/gvm/__version__.py

@@ -0,0 +1,5 @@
+# pylint: disable=invalid-name
+
+# THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
+
+__version__ = "24.3.0"

python_gvm-24.3.0/gvm/_enum.py

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2024 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from enum import Enum as PythonEnum
+from typing import Optional
+
+from typing_extensions import Self
+
+from gvm.errors import InvalidArgument
+
+
+class Enum(PythonEnum):
+    """
+    Base class for Enums in python-gvm
+    """
+
+    @classmethod
+    def from_string(
+        cls,
+        value: Optional[str],
+    ) -> Optional[Self]:
+        """
+        Convert a string value into an Enum instance
+
+        If value is None or empty None is returned
+        """
+        if not value:
+            return None
+
+        try:
+            return cls[value.replace(" ", "_").upper()]
+        except KeyError:
+            raise InvalidArgument(
+                f"Invalid argument {value} for {cls.__name__}.from_string. "
+                f"Allowed values are {','.join(e.name for e in cls)}."
+            ) from None