diff options
| author | Erik Skultety <eskultet@redhat.com> | 2023-03-31 09:25:45 +0200 |
|---|---|---|
| committer | Erik Skultety <eskultet@redhat.com> | 2023-03-31 11:44:34 +0200 |
| commit | 48c7e39e0f05810c30564f800813e00b15f3cf7c (patch) | |
| tree | 7a79b8a7798efa06b1da384d8be5f7d3885f4ebb /docs | |
| parent | a15fb83509a6208fb8f66bdda3a8bbfeef1a462e (diff) | |
| download | libvirt-ci-48c7e39e0f05810c30564f800813e00b15f3cf7c.zip libvirt-ci-48c7e39e0f05810c30564f800813e00b15f3cf7c.tar.gz libvirt-ci-48c7e39e0f05810c30564f800813e00b15f3cf7c.tar.bz2 | |
docs: installation: Update information on how to install the package
We recently switched from plain setup.py setup to be fully compatible
with PEP 517 relying solely on pyproject.toml (with setup.py reserved
for legacy reasons). Installation is now only possible with pip, so our
docs need an update.
Fixes: https://gitlab.com/libvirt/libvirt-ci/-/issues/20
Signed-off-by: Erik Skultety <eskultet@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installation.rst | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/docs/installation.rst b/docs/installation.rst index 7134195..996dd44 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -47,6 +47,17 @@ requires in the VM scenario $ pip3 install --user -r vm-requirements.txt +Note: In case you plan on installing lcitool itself (refer to `Installing +lcitool`_), you can install ``vm-requirements.txt`` along with lcitool in a +single step with: + +:: + + $ pip3 install .["vm_support"] + +where ``vm_support`` denotes the same set of dependencies as extra dependencies +in a way ``pip`` recognizes for installable packages. + Development dependencies ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -63,26 +74,34 @@ In addition, the ``ansible-inventory`` executable needs to be installed. Installing lcitool ------------------ -This is a standard python package, so you can install it either as your local -user +Like any other python package, you can install this using pip using one of the +following ways depending on your preference (run from the git root): + +in a Python virtual environment :: - $ python3 setup.py install --user + $ . <your_virtual_env>/bin/activate + (<your_virtual_env>) $ pip install . -or system-wide with +as your local user: :: - $ sudo python3 setup.py install + $ pip3 install --user . + +or system-wide with + +:: -If you prefer, you can have it installed inside a virtual-env too. + $ sudo pip3 install . -For development purposes you may find convenient to do +For development purposes you may find convenient to use an editable install +with pip like this: :: - $ python3 setup.py develop --user + $ pip3 install -e . which will create the necessary links to your working directory and so you won't need to re-install the lcitool package locally after every code change. |