Introduce public API for domain async job handling
[libvirt-python/ericb.git] / README
blob02d4cc4075a856a44427487bff0bf997c0cc33f6
1     libvirt Python Bindings README
2     ==============================
4 Most of the libvirt python binding code is automatically generated
5 using the script  generator.py, and the API description from
6 docs/libvirt-api.xml
9 Manually written files:
11  - libvirt-override.c: methods where the C binding needs to be hand crafted
12  - libvirt-override.py: global methods where the C and python bindings have different args
13  - libvirt-override-api.xml: methods where the auto-extracted API docs are not
14    suitable for python auto-generator. Overriding this if the method is going
15    into libvirt-override.c, but we still want auto-generated libvirt-override.py
16  - libvirt-override-virConnect.py: virConnect class methods
17  - typewrappers.h,.c: Python object wrappers for each libvirt C object
20 Auto-generated files:
22   - libvirt.py: The main python binding. Comprises auto-generated code, along
23     with contents from libvirt-override.py and libvirt-override-virConnect.py
24   - libvirt.c, libvirt.h: The C glue layer for the python binding. Comprises
25     auto-generated code, along with libvirt-override.c
26   - libvirt-export.c: List of auto-generated C methods, included into
27     the libvirt-override.c method table