Metadata-Version: 1.2
Name: python-gvm
Version: 21.6.0
Summary: Library to communicate with remote servers over GMP or OSP
Home-page: https://github.com/greenbone/python-gvm
Author: Greenbone Networks GmbH
Author-email: info@greenbone.net
License: UNKNOWN
Description: ![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_logo_resilience_horizontal.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/)
        [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/greenbone/python-gvm/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/greenbone/python-gvm/?branch=master)
        [![code test coverage](https://codecov.io/gh/greenbone/python-gvm/branch/master/graph/badge.svg)](https://codecov.io/gh/greenbone/python-gvm)
        [![Build and test](https://github.com/greenbone/python-gvm/actions/workflows/ci-python.yml/badge.svg)](https://github.com/greenbone/python-gvm/actions/workflows/ci-python.yml)
        
        The Greenbone Vulnerability Management Python API library (**python-gvm**) is a
        collection of APIs that help with remote controlling a Greenbone Security
        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 <!-- omit in toc -->
        
        - [Documentation](#documentation)
        - [Installation](#installation)
          - [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://python-gvm.readthedocs.io/](https://python-gvm.readthedocs.io/en/latest/).
        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 freqently 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.7 and later is supported.
        
        ### Install using pip
        
        pip 19.0 or later is required.
        
        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 Portal](https://community.greenbone.net/c/gmp). If you
        found a problem with the software, please
        [create an issue](https://github.com/greenbone/gvm-tools/issues)
        on GitHub.
        
        ## Maintainer
        
        This project is maintained by [Greenbone Networks GmbH](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
        
            python3 -m pip install --user poetry
        
        Afterwards run
        
            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-2021 [Greenbone Networks GmbH](https://www.greenbone.net/)
        
        Licensed under the [GNU General Public License v3.0 or later](LICENSE).
        
Platform: UNKNOWN
Requires-Python: >=3.7.0,<4.0.0
