shaba/libvirt-python
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt-python.git synced 2025-08-02 04:21:59 +03:00
Code Issues Projects Releases Activity

README: Drop direct 'setup.py' usage

Browse Source 
With all the bits in place we can now replace the direct 'setup.py'
invocation examples with alternatives.

Signed-off-by: Erik Skultety <eskultet@redhat.com>
This commit is contained in:
Erik Skultety
2023-06-20 12:21:27 +02:00
parent 333c8bef2b
commit b957ee3daf
1 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README
View File

@ -26,30 +26,38 @@ Building and installing
The module can be built by following the normal python module The module can be built by following the normal python module
build process build process
python setup.py build $ python3 -m build
sudo python setup.py install
or to install as non-root for testing and distributing purposes or it can be installed directly via pip
as
python setup.py build $ python3 -m pip install .
python setup.py install --user
If python-pytest is installed, you can test the package with without explicit building.
python setup.py test In order to test the package, you'll need either tox or at least pytest,
depending on whether you want to test an already installed package in which
case the latter is sufficient or if you wish to test in a virtual
environment you'd need tox. Depending on your preferred setup, you can run the
tests either as
A makefile shim is provided so that you can do $ python3 -m pytest
make && make check or as
rather than directly invoking setup.py. $ tox
A makefile shim is also provided for your convenience, so that you don't have
to care about the exact operations mentioned above and instead you simply do
$ make && make check
As of libvirt 1.2.6, it is possible to develop against an uninstalled As of libvirt 1.2.6, it is possible to develop against an uninstalled
libvirt.git checkout, by setting PKG_CONFIG_PATH and LD_LIBRARY_PATH libvirt.git checkout, by setting PKG_CONFIG_PATH and LD_LIBRARY_PATH
environment variables to point into that libvirt tree; you can even environment variables to point into that libvirt tree; you can even
automate this by using libvirt's run script: automate this by using libvirt's run script:
/path/to/libvirt/run python setup.py build /path/to/libvirt/run python3 -m build
Patches for this code should be submitted as merge requests to the Patches for this code should be submitted as merge requests to the
project page on gitlab. See CONTRIBUTING.rst for more information. project page on gitlab. See CONTRIBUTING.rst for more information.