@@ -4,42 +4,30 @@ Installation
44You will need Python 3.8 or higher to use StagPy. StagPy is available on
55the Python Package Index, via ``pip ``.
66
7- If you don't have sufficient permissions to install or update Python, you might
8- be interested in Miniconda _ or Anaconda _.
9-
10- .. _Miniconda : https://docs.conda.io/en/latest/miniconda.html
11- .. _Anaconda : https://www.anaconda.com/products/individual
7+ If you don't have sufficient permissions to install or update Python, you can
8+ use `pyenv to manage Python <https://github.com/pyenv/pyenv >`_.
129
1310Installation using ``pip ``
1411--------------------------
1512
16- If you don't have ``pip `` for Python3 on your system, use the ``ensurepip ``
17- module to install it (it is bootstrapped within the Python interpreter)::
18-
19- % python3 -m ensurepip
13+ In most cases, installing StagPy with ``pip `` should be as simple as::
2014
21- In case this doesn't work, download the official script
22- <https://bootstrap.pypa.io/get-pip.py> and run it with ``python3 ``.
15+ % python3 -m pip install stagpy
2316
24- Then, update ``pip `` to the latest version::
17+ It might be preferable or even necessary to install StagPy in a virtual
18+ environment to isolate it from other packages that could conflict with it::
2519
26- % python3 -m pip install -U pip
20+ % python3 -m venv stagpyenv
21+ % source stagpyenv/bin/activate
22+ % python3 -m pip install stagpy
2723
28- You can then install and/or update StagPy with the following command::
24+ You can then update StagPy with the following command::
2925
3026 % python3 -m pip install -U stagpy
3127
32- Make sure that the directory where ``pip `` install package entry-points
33- (usually ``~/.local/bin ``) is in your ``PATH `` environment variable.
34- You can run ``python3 -m pip show stagpy `` to obtain some hint about this
35- location (this command will show you were the compiled sources are installed,
36- e.g. ``~/.local/lib/python3.8/site-packages ``, from which you can deduce the
37- entry-point location, e.g. ``~/.local/bin ``).
38-
39- See the `Some setup `_ subsection to enable autocompletion and create your
40- config file.
41-
42- .. _somesetup :
28+ See the
29+ `official documentation <https://packaging.python.org/en/latest/tutorials/installing-packages/ >`_
30+ for more information about installing Python packages.
4331
4432Some setup
4533----------
0 commit comments