README

   1      Libvirt Python Binding README
   2      =============================
   3
   4 This package provides a python binding to the libvirt.so,
   5 libvirt-qemu.so and libvirt-lxc.so library APIs.
   6
   7 It is written to build against any version of libvirt that
   8 is 0.9.11 or newer.
   9
  10 This code is distributed under the terms of the LGPL version
  11 2 or later.
  12
  13 The module can be built by following the normal python module
  14 build process
  15
  16   python setup.py build
  17   sudo python setup.py install
  18
  19 or to install as non-root
  20
  21   python setup.py build
  22   python setup.py install --user
  23
  24 If python-nose is installed, you can test the package with
  25
  26   python setup.py test
  27
  28 A makefile shim is provided so that you can do
  29
  30   make && make check
  31
  32 rather than directly invoking setup.py.
  33
  34 As of libvirt 1.2.6, it is possible to develop against an uninstalled
  35 libvirt.git checkout, by setting PKG_CONFIG_PATH and LD_LIBRARY_PATH
  36 environment variables to point into that libvirt tree; you can even
  37 automate this by using libvirt's run script:
  38
  39   /path/to/libvirt/run python setup.py build
  40
  41 Patches for this code should be sent to the main libvirt
  42 development mailing list
  43
  44   http://libvirt.org/contact.html#email
  45
  46 To send patches, it is strongly recommended to use the
  47 'git send-email' command.
  48
  49 Make sure the mails mention that the patch is for the python
  50 binding. This can be done by setting a config parameter in the
  51 local git checkout
  52
  53   git config format.subjectprefix "PATCH python"