Installation of gvm-tools

The current universally applicable installation process for Python is using the pip installer tool in conjunction with the pypi package repository.

Note

All commands listed here use the general tool names. If some of these tools are provided by your distribution, you may need to explicitly use the Python 3 version of the tool, e.g. pip3.

Installing the Latest Stable Release of gvm-tools

For installing the latest stable release of gvm-tools from the Python Package Index, pip or pipenv can be used.

Using pip

The following command installs gvm-tools system wide:

pip install gvm-tools

A system wide installation usually requires admin permissions. Therefore, gvm-tools may only be installed for the current user via:

pip install --user gvm-tools

For further details and additional installation options, please take a look at the documentation of pip.

Using pipenv

To avoid polluting the system and user namespaces with Python packages and to allow installing different versions of the same package at the same time, python virtual environments have been introduced.

pipenv is a tool combining the use of virtual environments and pip elegantly.

Please follow the pipenv documentation to install the tool.

To install gvm-tools into a virtual environment, the following commands need to be executed:

mkdir path/to/venv/dir
cd path/to/venv/dir
pipenv install gvm-tools

Afterwards, the environment containing the installed gvm-tools can be activated by running:

cd path/to/venv/dir
pipenv shell

Getting the Source

The source code of python-gvm can be found at GitHub.

To clone the public repository run:

git clone git://github.com/greenbone/gvm-tools

Once there is a copy of the source, it can be installed into the current Python environment:

pip install -e /path/to/gvm-tools