README

   1 Libvirt Python Binding README
   2 =============================
   3
   4 This package provides a module that permits applications
   5 written in the Python 3.x programming language to call the interface
   6 supplied by the libvirt library, to manage the virtualization
   7 capabilities of recent versions of Linux (and other OSes).
   8 As such, the module exposes Python bindings to to the libvirt.so,
   9 libvirt-qemu.so and libvirt-lxc.so library APIs.
  10
  11 It is written to build against any version of libvirt that
  12 is 0.9.11 or newer.
  13
  14 This code is distributed under the terms of the LGPL version
  15 2 or later.
  16
  17 Requirements
  18 ------------
  19
  20 To build the libvirt python binary requires the GCC and pkg-config
  21 tools, and development headers for the libvirt and python libraries.
  22
  23 Building and installing
  24 -----------------------
  25
  26 The module can be built by following the normal python module
  27 build process
  28
  29   $ python3 -m build
  30
  31 for testing and distributing purposes or it can be installed directly via pip
  32 as
  33
  34   $ python3 -m pip install .
  35
  36 without explicit building.
  37
  38 In order to test the package, you'll need either tox or at least pytest,
  39 depending on whether you want to test an already installed package in which
  40 case the latter is sufficient or if you wish to test in a virtual
  41 environment you'd need tox. Depending on your preferred setup, you can run the
  42 tests either as
  43
  44   $ python3 -m pytest
  45
  46 or as
  47
  48   $ tox
  49
  50 A makefile shim is also provided for your convenience, so that you don't have
  51 to care about the exact operations mentioned above and instead you simply do
  52
  53   $ make && make check
  54
  55 As of libvirt 1.2.6, it is possible to develop against an uninstalled
  56 libvirt.git checkout, by setting PKG_CONFIG_PATH and LD_LIBRARY_PATH
  57 environment variables to point into that libvirt tree; you can even
  58 automate this by using libvirt's run script:
  59
  60   /path/to/libvirt/run python3 -m build
  61
  62 Patches for this code should be submitted as merge requests to the
  63 project page on gitlab. See CONTRIBUTING.rst for more information.