Updated sample.py with recent opensync library python API changes
[opensync/python-module.git] / README
blob445e9076d4cf14efc669092945e95e1c348aee2b
1 This is an OSYNC_START_TYPE_EXTERNAL plugin helper, as well as a
2 sample python plugin script which makes use of it.
4 src/python_module.c
5         This is the helper program, and gets installed as
6         /usr/bin/osync1_python_module.  This is referenced by the XML
7         config for the EXTERNAL plugin.
9 src/python-sample.xml
10         This is the XML config for the sample python plugin.  It gets
11         copied into the plugins/ directory, representing the new python-sample
12         plugin.
14 src/python-sample
15         This is the sample plugin config file for the python-sample plugin.
16         It is copied to the defaults/ directory as a starting point to
17         configure the plugin.
19 src/sample.py
20         This is the python code to the python-sample plugin.  It gets copied
21         to the python-plugins/ directory.
23         Inside the sample.py code are various comments on how to convert
24         the sample to a OSYNC_PLUGIN_NO_CONFIGURATION style plugin.
25         To run it that way, you will need to follow the comments and
26         modify sample.py, as well as modify python-sample.xml to set
27         NO_CONFIGURATION.