mirror of
https://gitlab.com/libvirt/libvirt-python.git
synced 2025-07-22 20:59:34 +03:00
38bb83e914
The sanity check scripts verify that the binding covers all APIs in the libvirt library/headers being built against. This is primarily there for libvirt maintainers to identify when there are gaps in API coverage. This is not something downstream consumers of libvirt-python should be running themselves, so we shouldn't added it to tests by default. In addition if people are working on branches or submitting merge requests for python changes, we shouldn't block their work for failed API coverage sanity tests, if the python binding otherwise builds fine and passes regular unit tests. Thus, we introduce a new gitlab job "api-coverage" with some conditions: - If pushing to a branch, the job is treated as non-fatal - For regular scheduled builds, it is mandatory - Don't run in any other scenarios This job uses the artifacts from the centos-8-git-build job and re-runs the test suite, requesting the sanity tests to be run too. This will achieve the result of letting us see missing API coverage in nightly builds, without blocking other contributions. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
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-nose 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"