zuul/zuul-client
Code Issues Proposed changes

Reorganize the installation documentation, specify versions

Browse Source 
Move the PyPI installation method to the first place. Specify
which versions of zuul-client can be installed from PyPI or by
using containers.

Change-Id: I2e84473f84e06e350b87581d6edc61742653ace3
This commit is contained in:
Matthieu Huin 2020-12-17 18:16:22 +01:00
parent 30988f5725
commit 7908933545
1 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/source/installation.rst
View File

@ -32,22 +32,11 @@ The pip executable will be pre-installed in the virtual environment.
More information on virtual environments here: https://docs.python.org/3/library/venv.html
From source
-----------
Within a virtual environment or after having installed pip on your system:
*Install dependencies*::
pip install -r requirements.txt
*Install zuul-client*::
python setup.py install
Via the Python Package Index (PyPI)
-----------------------------------
The Python Package Index (PyPI) hosts the latest tagged version of zuul-client.
Within a virtual environment or after having installed pip on your system:
*Install zuul-client*::
@ -65,8 +54,26 @@ zuul-client container.
[docker | podman] pull docker.io/zuul/zuul-client
The above command will pull the *latest* version of zuul-client, ie at its current
state on the master branch. Alternatively, you can pull any tagged version of
zuul-client above 0.0.3::
[docker | podman] pull docker.io/zuul/zuul-client:x.y.z
where **x.y.z** is the desired tagged version.
*Run zuul-client from the container*::
[docker | podman] run zuul/zuul-client --help
[docker | podman] run docker.io/zuul/zuul-client --help
Please refer to the container engine's documentation for more runtime options.
From source
-----------
Within a virtual environment or after having installed pip on your system:
*Install zuul-client*::
pip install .