2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
1. REQUIREMENTS:
|
2013-02-25 11:05:17 -08:00
|
|
|
----------------
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-12-28 08:26:52 -08:00
|
|
|
* Python 2.6 or higher (http://www.python.org/)
|
|
|
|
- Tested with Python 2.6 / 2.7 / 3.2 / 3.3
|
2013-02-25 11:05:17 -08:00
|
|
|
|
2014-04-04 20:35:32 -07:00
|
|
|
* Cython 0.19 or higher (http://cython.org/)
|
|
|
|
- Tested with Cython 0.19.1
|
2013-02-25 11:05:17 -08:00
|
|
|
|
|
|
|
* EFL core library
|
2013-05-12 10:15:09 -07:00
|
|
|
- eo, evas, ecore, edje, emotion and elementary
|
2013-02-25 11:05:17 -08:00
|
|
|
|
|
|
|
* pkg-config (http://www.freedesktop.org/wiki/Software/pkg-config)
|
2013-02-14 12:54:53 -08:00
|
|
|
- Windows executable (and GLib dependency) can be downloaded from
|
|
|
|
http://www.gtk.org/download/win32.php
|
|
|
|
|
2013-02-25 11:05:17 -08:00
|
|
|
* To build the DOCS you will also need:
|
2013-02-28 08:13:07 -08:00
|
|
|
- python-sphinx
|
|
|
|
- [optional] graphviz
|
|
|
|
- [optional] youtube module from the sphinx contrib repository.
|
2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
|
2013-02-25 11:05:17 -08:00
|
|
|
|
|
|
|
2. BUILDING PYTHON-EFL:
|
|
|
|
-----------------------
|
2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
Once EFL is built and installed in your desired destination, proceed with
|
2014-05-16 00:14:15 -07:00
|
|
|
building the wrapper. The setup script can be forced to use purely C
|
|
|
|
sources by setting the environment variable DISABLE_CYTHON to 1.
|
2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
|
2014-10-09 23:54:07 -07:00
|
|
|
* BUILDING THE EOLIAN BINDINGS (system installation not required)
|
|
|
|
|
|
|
|
python setup_eolian.py build
|
|
|
|
|
2013-02-25 11:05:17 -08:00
|
|
|
* BUILDING WITH GCC/G++ (Linux, OS X, etc.)
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-09-15 06:16:44 -07:00
|
|
|
python setup.py build
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-02-25 11:05:17 -08:00
|
|
|
* BUILDING WITH Visual Studio (Windows)
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-09-15 06:16:44 -07:00
|
|
|
python setup.py build
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-02-25 11:05:17 -08:00
|
|
|
* BUILDING WITH MINGW (Windows)
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-09-15 06:16:44 -07:00
|
|
|
python setup.py build -c mingw32
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2014-05-16 00:14:15 -07:00
|
|
|
* FORCING C SOURCES FOR BUILD
|
2014-04-30 08:59:19 -07:00
|
|
|
|
2014-05-16 00:14:15 -07:00
|
|
|
env DISABLE_CYTHON=1 python setup.py build
|
2014-04-30 08:59:19 -07:00
|
|
|
|
2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
|
2014-07-23 13:05:59 -07:00
|
|
|
3. CLEANUP:
|
|
|
|
-----------
|
|
|
|
* For cleaning up
|
|
|
|
|
|
|
|
python setup.py clean_generated_files
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4. INSTALLATION:
|
2013-02-25 11:05:17 -08:00
|
|
|
----------------
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-02-25 11:05:17 -08:00
|
|
|
* For system-wide installation (needs administrator privileges):
|
2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
python setup.py install
|
|
|
|
|
2013-02-25 11:05:17 -08:00
|
|
|
* For user installation:
|
2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
python setup.py install --user
|
|
|
|
|
2013-02-25 11:05:17 -08:00
|
|
|
* To install for python3:
|
2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
python3 setup.py install (also cython need to be installed with py3)
|
|
|
|
|
2013-05-04 10:15:09 -07:00
|
|
|
* Install with a custom prefix:
|
|
|
|
|
|
|
|
python setup.py install --prefix=/MY_PREFIX
|
|
|
|
|
2013-02-14 12:54:53 -08:00
|
|
|
|
|
|
|
|
2014-07-23 13:05:59 -07:00
|
|
|
5. DOCUMENTATION:
|
2013-02-25 11:05:17 -08:00
|
|
|
-----------------
|
|
|
|
|
2013-02-28 08:13:07 -08:00
|
|
|
To build the docs for the bindings you need to have Sphinx installed, for
|
|
|
|
(optional) graphs you need Graphviz, for (optional) Youtube demonstration
|
|
|
|
videos you need the YouTube module from sphinx contrib repository.
|
2013-09-15 06:16:44 -07:00
|
|
|
packages: python-sphinx, graphviz, python-pygraphviz, libgv-python
|
2013-02-25 11:05:17 -08:00
|
|
|
|
2013-03-27 13:18:24 -07:00
|
|
|
To build the docs just run:
|
2013-02-25 11:05:17 -08:00
|
|
|
python setup.py build_doc
|
|
|
|
|
|
|
|
You will find the generated html docs under the folder:
|
|
|
|
build/sphinx/html
|
2013-02-28 08:13:07 -08:00
|
|
|
|
2013-03-27 13:18:24 -07:00
|
|
|
Note: you must build the bindings before building the docs, or you will end
|
|
|
|
up with empty documentation.
|
2013-02-25 11:05:17 -08:00
|
|
|
|
|
|
|
|
2014-07-23 13:05:59 -07:00
|
|
|
6. TESTS and EXAMPLES:
|
2013-02-25 11:05:17 -08:00
|
|
|
----------------------
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-02-28 08:13:07 -08:00
|
|
|
The tests/ folder contains all the unit tests available, you can run individual
|
2013-02-16 02:47:27 -08:00
|
|
|
tests or use the 00_run_all_tests.py in each folder or even in the tests/ base
|
|
|
|
dir to run all the tests at once.
|
2013-02-14 12:54:53 -08:00
|
|
|
|
2013-12-28 08:26:52 -08:00
|
|
|
Python 2.7 is required for running the tests.
|
|
|
|
|
2013-02-28 08:13:07 -08:00
|
|
|
The scripts in examples/ folder must be run by the user as they require
|
|
|
|
user interaction.
|
2013-02-25 11:05:17 -08:00
|
|
|
|
|
|
|
|
|
|
|
|
2014-07-23 13:05:59 -07:00
|
|
|
7. UNINSTALL:
|
2013-02-25 11:05:17 -08:00
|
|
|
-------------
|
|
|
|
|
2013-02-28 08:13:07 -08:00
|
|
|
Unfortunately setup.py does not provide a way to remove the installed packages,
|
2013-02-25 11:05:17 -08:00
|
|
|
|
2013-02-28 08:13:07 -08:00
|
|
|
To completely remove the installed stuff just remove the 'efl' folder in
|
2013-02-25 11:05:17 -08:00
|
|
|
your python installation, usually /usr/(local/)lib/pythonX.X/dist-packages/efl
|
|
|
|
|
|
|
|
|