Skip to content

Commit d1d602e

Browse files
committed
Change: Improve installation chapter
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.
1 parent bb730e6 commit d1d602e

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

docs/install.rst

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,21 @@
33
Installation of python-gvm
44
==========================
55

6-
.. note:: All commands listed here use the general tool names. If some of these
7-
tools are provided by the distribution, the Python 3 version of the tool may
8-
have to be used, e.g. :program:`pip3`.
9-
10-
Installing the Latest Stable Release of python-gvm
11-
--------------------------------------------------
12-
136
For installing the latest stable release of **python-gvm**, `pip`_, `poetry`_
147
or `pipenv`_ can be used.
158

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

1912
Using pip
20-
^^^^^^^^^
13+
---------
2114

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

24-
pip install python-gvm
17+
python3 -m pip install python-gvm
2518

2619
Using poetry
27-
^^^^^^^^^^^^
20+
------------
2821

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

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

3629
Using pipenv
37-
^^^^^^^^^^^^
30+
------------
3831

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

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

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

58-
pip install -e /path/to/python-gvm
51+
python3 -m pip install -e /path/to/python-gvm
5952

6053
.. _pip: https://pip.pypa.io/en/stable/
6154
.. _pipenv: https://pipenv.readthedocs.io/en/latest/

0 commit comments

Comments
 (0)