aboutsummaryrefslogtreecommitdiffstats
path: root/eo_py/README
diff options
context:
space:
mode:
Diffstat (limited to 'eo_py/README')
-rw-r--r--eo_py/README55
1 files changed, 0 insertions, 55 deletions
diff --git a/eo_py/README b/eo_py/README
deleted file mode 100644
index 85b4e29..0000000
--- a/eo_py/README
+++ /dev/null
@@ -1,55 +0,0 @@
-############################################################################
-
-EO Introspection - Python Bindings
-
-############################################################################
-
-It analyzes XML files generated by EO introspection scanner and generates
-python module.
-
-############################################################################
-
-1. Generating python module for classes defined in XMLs:
- a. > python eo_py_gen.py --dir=XML_FOLDER --outdir=OUTDIR --pkg="lib1 lib2"
- --module=MODULE_NAME --include=INCLUDE_DIR
- In case if some class is needed (usually parent class, which is not in the tree being analyzed),
- include XMLs are searched in python system paths.
- If include file wasn't found, explicit --include=INCLUDE_DIR dir is needed
-
- Files to be generated:
- - MODULE_NAME.pyx
- - *.pxi, *.pxd will be created for each *.xml
- - setup.py
- setup.py can be edited in order to add include paths and libraries,
- which were not mentioned in --pkg option
- b. Compiling module:
- > python setup.py build_ext --inplace
- - py_module.so will be generated.
-
- Put module into python search path and import into your code.
-
-############################################################################
-############################################################################
-############################################################################
-
-1. Creating eobase module:
- a. Create new dir - PY_EOBASE
- b. Base module folder being introspected - EOBASE
- > python eo_xml_gen.py --dir=EOBASE --outdir=PY_EOBASE
- - eobase.xml will be created in PY_EOBASE
- c. Creating eobase python sources:
- > python eo_py_gen.py --dir=PY_EOBASE --outdir=PY_EOBASE --module=eobase
- --pkg="elementary eo"
- To create base module, option --module must be "eobase"
- - eobase.pxd, eobase.pyx - will be created
- - eodefault.pxd, eodefault.pyx - will be copied into PY_EOBASE
- - setup.py will be created.
- setup.py can be modified in order to add include paths and libraries,
- which weren't mentioned in --pkg option
- d. Compiling python sources into python module.
- > python setup.py build_ext --inplace
- - eodefault.so, eobase.so will be created
- e. Copy __init__.py to PY_EOBASE
- Add PYTHONPATH = PY_EOBASE
-
-