README.md
1# Python bindings
2
3These are bindings on the `CParameterMgrFullConnector` class, its inner
4`Ilogger` class and both classes involved in the SelectionCriterion creation.
5
6They are complete enough to write a parameter-framework client in Python and
7also access most of the tuning interface.
8
9## Generation
10
11The bindings are defined unsing SWIG in the `pfw.i` file and the actual source
12files are generated by the command found in `regen_swig.sh`. This command must
13be re-run whenever any file in `parameter/include` is modified.
14
15Two things are generated:
16
17- A C++ source file providing a low-level wrapping of the parameter-framework
18 classes. When compiled as a shared library, it can be imported from Python as
19 a module called `_PyPfw` but this module is not for direct use.
20- A Python module called `PyPfw`, using `PyPfw`, providing proxy classes of the
21 parameter-framework's native classes. *Please not that in the context of the
22 Python bindings, the `CParameterMgrFullConnector` class is renamed
23 `ParameterFramework`.*
24
25## Usage
26
27`sample.py` provides an example of how to use the PyPfw module. Note that the
28PYTHONPATH env variable must contain the directory of both `_PyPfw.so` and
29`PyPfw.py`.
30