Skip to content

Commit

Permalink
Change: Improve installation chapter
Browse files Browse the repository at this point in the history
Use the module call for pip (`python3 -m pip`) which should work on all
systems. This allows to remove the note for pip3 and restructure the
headings.
  • Loading branch information
bjoernricks committed Aug 11, 2022
1 parent bb730e6 commit d1d602e
Showing 1 changed file with 5 additions and 12 deletions.
17 changes: 5 additions & 12 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,21 @@
Installation of python-gvm
==========================

.. note:: All commands listed here use the general tool names. If some of these
tools are provided by the distribution, the Python 3 version of the tool may
have to be used, e.g. :program:`pip3`.

Installing the Latest Stable Release of python-gvm
--------------------------------------------------

For installing the latest stable release of **python-gvm**, `pip`_, `poetry`_
or `pipenv`_ can be used.

If an application or library that uses **python-gvm** internally is developed,
it is often better to choose `poetry`_ for handling the dependencies.

Using pip
^^^^^^^^^
---------

For installing **python-gvm** using `pip`_ run::

pip install python-gvm
python3 -m pip install python-gvm

Using poetry
^^^^^^^^^^^^
------------

For installing **python-gvm** using `poetry`_ run::

Expand All @@ -34,7 +27,7 @@ If the usage of `poetry`_ is not familiar, its documentation can be found at
https://python-poetry.org/docs/.

Using pipenv
^^^^^^^^^^^^
------------

For installing **python-gvm** using `pipenv`_ run::

Expand All @@ -55,7 +48,7 @@ To clone the public repository run::

Once there is a copy of the source, it can be embedded it the own application as follows::

pip install -e /path/to/python-gvm
python3 -m pip install -e /path/to/python-gvm

.. _pip: https://pip.pypa.io/en/stable/
.. _pipenv: https://pipenv.readthedocs.io/en/latest/
Expand Down

0 comments on commit d1d602e

Please sign in to comment.