1
0
mirror of https://gitlab.com/libvirt/libvirt-python.git synced 2024-10-26 07:55:06 +03:00
libvirt-python/README
Jonathon Jongsma 2c9ad18dd1 Update readme to mention pytest instead of nose
Commit a376a2ab switch from python-nose to python-pytest for tests, but
the README was not updated.

Signed-off-by: Jonathon Jongsma <jjongsma@redhat.com>
2021-09-21 16:11:07 -05:00

63 lines
1.6 KiB
Plaintext

Libvirt Python Binding README
=============================
This package provides a python binding to the libvirt.so,
libvirt-qemu.so and libvirt-lxc.so library APIs.
It is written to build against any version of libvirt that
is 0.9.11 or newer.
This code is distributed under the terms of the LGPL version
2 or later.
Requirements
------------
To build the libvirt python binary requires the GCC and pkg-config
tools, and development headers for the libvirt and python libraries.
Building and installing
-----------------------
The module can be built by following the normal python module
build process
python setup.py build
sudo python setup.py install
or to install as non-root
python setup.py build
python setup.py install --user
If python-pytest is installed, you can test the package with
python setup.py test
A makefile shim is provided so that you can do
make && make check
rather than directly invoking setup.py.
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
environment variables to point into that libvirt tree; you can even
automate this by using libvirt's run script:
/path/to/libvirt/run python setup.py build
Patches for this code should be sent to the main libvirt
development mailing list
http://libvirt.org/contact.html#email
To send patches, it is strongly recommended to use the
'git send-email' command.
Make sure the mails mention that the patch is for the python
binding. This can be done by setting a config parameter in the
local git checkout
git config format.subjectprefix "PATCH python"