Finalize gmp8 part 1

CHANGELOG.md

@@ -19,8 +19,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added Gmpv8 version of modify_tag with resource_action parameter,
   resource_filter parameter, plural resource_ids parameter [PR 115](https://github.com/greenbone/python-gvm/pull/115)
 * Added no_details argument to `get_reports` method [PR 129](https://github.com/greenbone/python-gvm/pull/129)
+* Added `get_vulnerabilites` method [PR 132](https://github.com/greenbone/python-gvm/pull/132)
+* Added `get_ticket`, `get_tickets`, `create_ticket`, `clone_ticket`, `modify_ticket` and `delete_ticket`
+  APIs to GMPv8 [PR 132](https://github.com/greenbone/python-gvm/pull/132)
 
 ### Changed
+* Use Gmpv8 as latest Gmp version [PR 132](https://github.com/greenbone/python-gvm/pull/132)
 * Aligned ALIVE_TESTS declaration with list from GSA [PR 93](https://github.com/greenbone/python-gvm/pull/93)
 * Refactor `modify_task` to use same arguments as `create_task` [PR 89](https://github.com/greenbone/python-gvm/pull/89)
 * Allow to pass either user_id or name to `delete_user` [PR 88](https://github.com/greenbone/python-gvm/pull/88)
@@ -50,6 +54,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Make resource_id optional when creating tags (Gmpv7) [PR 124](https://github.com/greenbone/python-gvm/pull/124)
 * Allow creating tags without resource (Gmpv8) [PR 125](https://github.com/greenbone/python-gvm/pull/125)
 * Adapt modify_tag validation to actual implementation (Gmpv8) [PR 127](https://github.com/greenbone/python-gvm/pull/127)
+* Introduced new CredentialType Enum for Gmpv8 and expect an instance of CredentialType
+  for `create_credential` and `modify_credential` `credential_type` argument [PR 132](https://github.com/greenbone/python-gvm/pull/132)
 
 ### Removed
 * Removed hosts_ordering argument from `modify_target` [PR 88](https://github.com/greenbone/python-gvm/pull/88)

README.md

@@ -1,6 +1,6 @@
 ![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_logo_resilience_horizontal.png)
 
-# Greenbone Vulnerability Management Python Library
+# 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/gvm.svg)](https://pypi.org/project/python-gvm/)
@@ -14,16 +14,17 @@ Manager (GSM) appliance and its underlying Greenbone Vulnerability Manager
 (GVM). The library essentially abstracts accessing the communication protocols
 Greenbone Management Protocol (GMP) and Open Scanner Protocol (OSP).
 
-## Table of Contents
+## Table of Contents <!-- omit in toc -->
 
-* [Installation](#installation)
-  * [Requirements](#requirements)
-  * [Install using pip](#install-using-pip)
-* [Example](#example)
-* [Support](#support)
-* [Maintainer](#maintainer)
-* [Contributing](#contributing)
-* [License](#license)
+- [Installation](#installation)
+  - [Requirements](#requirements)
+  - [Install using pip](#install-using-pip)
+- [Example](#example)
+- [Documentation](#documentation)
+- [Support](#support)
+- [Maintainer](#maintainer)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -36,12 +37,7 @@ Python 3.5 and later is supported.
 You can install the latest stable release of python-gvm from the Python Package
 Index using [pip](https://pip.pypa.io/):
 
-    pip install python-gvm
-
-alternatively download or clone this repository and install the latest
-development version:
-
-    pip install .
+    pip install --user python-gvm
 
 ## Example
 

docs/api/protocols.rst

@@ -15,6 +15,15 @@ GMP v7
 
 .. automodule:: gvm.protocols.gmpv7
 
+.. autoclass:: Gmp
+    :members:
+    :inherited-members:
+
+GMP v8
+^^^^^^
+
+.. automodule:: gvm.protocols.gmpv8
+
 .. autoclass:: Gmp
     :members:
     :inherited-members:

gvm/protocols/gmpv7.py

@@ -368,7 +368,7 @@ def clone_agent(self, agent_id):
         """Clone an existing agent
 
         Arguments:
-            copy (str): UUID of an existing agent to clone from
+            agent_id (str): UUID of an existing agent to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -469,7 +469,7 @@ def clone_alert(self, alert_id):
         """Clone an existing alert
 
         Arguments:
-            copy (str): UUID of an existing alert to clone from
+            alert_id (str): UUID of an existing alert to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -721,7 +721,7 @@ def clone_credential(self, credential_id):
         """Clone an existing credential
 
         Arguments:
-            copy (str): UUID of an existing credential to clone from
+            credential_id (str): UUID of an existing credential to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -785,7 +785,7 @@ def clone_filter(self, filter_id):
         """Clone an existing filter
 
         Arguments:
-            copy (str): UUID of an existing filter to clone from
+            filter_id (str): UUID of an existing filter to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -832,7 +832,7 @@ def clone_group(self, group_id):
         """Clone an existing group
 
         Arguments:
-            copy (str): UUID of an existing group to clone from
+            group_id (str): UUID of an existing group to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -942,7 +942,7 @@ def clone_note(self, note_id):
         """Clone an existing note
 
         Arguments:
-            copy (str): UUID of an existing note to clone from
+            note_id (str): UUID of an existing note to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -1052,7 +1052,7 @@ def clone_override(self, override_id):
         """Clone an existing override
 
         Arguments:
-            copy (str): UUID of an existing override to clone from
+            override_id (str): UUID of an existing override to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -1136,7 +1136,7 @@ def clone_permission(self, permission_id):
         """Clone an existing permission
 
         Arguments:
-            copy (str): UUID of an existing permission to clone from
+            permission_id (str): UUID of an existing permission to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -1183,7 +1183,7 @@ def clone_port_list(self, port_list_id):
         """Clone an existing port list
 
         Arguments:
-            copy (str): UUID of an existing port list to clone from
+            port_list_id (str): UUID of an existing port list to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -1326,7 +1326,7 @@ def clone_role(self, role_id):
         """Clone an existing role
 
         Arguments:
-            copy (str): UUID of an existing role to clone from
+            role_id (str): UUID of an existing role to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -1413,7 +1413,7 @@ def clone_scanner(self, scanner_id):
         """Clone an existing scanner
 
         Arguments:
-            copy (str): UUID of an existing scanner to clone from
+            scanner_id (str): UUID of an existing scanner to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -1619,7 +1619,7 @@ def clone_schedule(self, schedule_id):
         """Clone an existing schedule
 
         Arguments:
-            copy (str): UUID of an existing schedule to clone from
+            schedule_id (str): UUID of an existing schedule to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -1693,7 +1693,7 @@ def clone_tag(self, tag_id):
         """Clone an existing tag
 
         Arguments:
-            copy (str): UUID of an existing tag to clone from
+            tag_id (str): UUID of an existing tag to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -1834,7 +1834,7 @@ def clone_target(self, target_id):
         """Clone an existing target
 
         Arguments:
-            copy (str): UUID of an existing target to clone from
+            target_id (str): UUID of an existing target to clone from
 
         Returns:
             The response. See :py:meth:`send_command` for details.
@@ -2576,7 +2576,7 @@ def get_agent(self, agent_id):
     def get_aggregates(self, resource_type, **kwargs):
         """Request aggregated information on a resource type
 
-        Additional arguments can be set via the **kwargs parameter, but are not
+        Additional arguments can be set via the kwargs parameter, but are not
         yet validated.
 
         Arguments: