This is an automated email from the git hooks/post-receive script.
git pushed a commit to branch master
in repository python-efl.
View the commit online.
commit b97b77852707a85c70faf6488097a80facea5713
Author: Dave Andreoli <d...@gurumeditation.it>
AuthorDate: Sat Aug 30 10:46:16 2025 +0200
Merge Readme and INSTALL files
---
INSTALL | 111 ------------------------------------------------------------
MANIFEST.in | 2 +-
README.md | 34 ++++++++++++++-----
3 files changed, 27 insertions(+), 120 deletions(-)
diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index 9a09f41..0000000
--- a/INSTALL
+++ /dev/null
@@ -1,111 +0,0 @@
-
-1. REQUIREMENTS
-===============
-
- * Python 3.2 or higher (http://www.python.org/)
-
- * Cython 3.0 or higher (http://cython.org/)
-
- * EFL must be the same minor version of the bindings,
- es. python-efl 1.24 need efl 1.24
-
- * To build the DOCS you will also need:
- - python-sphinx
- - [optional] graphviz
-
- * At least 4GB of free RAM to build
-
-
-2. BUILDING PYTHON-EFL
-======================
-
- Once EFL is built and installed in your desired destination, proceed with
- building the wrapper using:
-
- python setup.py build
-
- IMPORTANT NOTE:
- To build the bindings you will need at least 4GB of free ram!
- Otherwise the build process will badly fail.
-
-
- Distribution tarballs include pre-generated C source files, so
- cython usage is disabled by default, while is enabled in development git
- versions. You can always force the usage of cython using two environment
- variables: DISABLE_CYTHON or ENABLE_CYTHON
-
-
- * FORCE C SOURCES FOR BUILD
-
- env DISABLE_CYTHON=1 python setup.py build
-
-
- * FORCE THE USAGE OF CYTHON
-
- env ENABLE_CYTHON=1 python setup.py build
-
-
-
-3. CLEANUP
-==========
-
- * For cleaning up:
-
- python setup.py clean --all
-
- * To also remove all the C/HTML files generated by Cython:
-
- python setup.py clean_generated_files
-
- WARNING: you will need cython to regenerate the C files, do not use this
- in distribution tarballs, unless you know what are you doing.
-
-
-
-4. INSTALLATION
-===============
-
- * For system-wide installation (needs administrator privileges):
-
- (sudo) python setup.py install
-
- * For user installation:
-
- python setup.py install --user
-
- * Install with a custom prefix:
-
- (sudo) python setup.py install --prefix=/MY_PREFIX
-
-
-
-5. DOCUMENTATION
-================
-
- 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.
- packages: python-sphinx, graphviz, python-pygraphviz, libgv-python
-
- To build the docs run:
- python -m sphinx . ../build/docs/ (from the doc/ directory!)
- or simply:
- make doc (from base source directory)
-
- You will find the generated html docs under the folder:
- build/docs/
-
- Note: you must have python-efl installed for building the docs, or you
- will end up with empty documentation.
-
-
-6. TESTS and EXAMPLES
-=====================
-
- The tests/ folder contains all the unit tests available, you can run individual
- 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.
-
- The scripts in examples/ folder must be run by the user as they require
- user interaction.
-
diff --git a/MANIFEST.in b/MANIFEST.in
index ad78156..a91d783 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,2 +1,2 @@
-include README.md INSTALL COPYING COPYING.LESSER AUTHORS ChangeLog
+include README.md COPYING COPYING.LESSER AUTHORS ChangeLog
exclude Makefile
diff --git a/README.md b/README.md
index b4d2c97..2b1bdfa 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ The documentation for Python-EFL is available [here](https://docs.enlightenment.
The last stable release is always available on pypi, and pip is the raccomanded way to install Python-EFL:
```
-pip install python-efl
+(sudo) pip install python-efl
```
The only requirement is to have the EFL already installed on your machine, see [here](https://www.enlightenment.org/docs/distros/start) for install instructions for various linux distro or for building EFL from sources.
@@ -23,13 +23,16 @@ NOTE: Currently only sources packages are available on pip, this means that the
All the stable releases of python-efl can always be found at:
https://download.enlightenment.org/rel/bindings/python/
-To install download and unpack a tarball and run:
+Tarball only contain cython generated C files, the cython sources are not included. So cython is not needed to build from tarballs. If you need to rebuild the C files you must use a version from git (see below).
+
+To install unpack the tarball and run:
+```
+(sudo) python -m pip install . --verbose
+```
+
+or use build to only create the sdist/wheel packages:
```
python -m build
-python -m pip install dist/python-efl-X.Y.Z.whl
-
-or
-sudo python -m pip install dist/python-efl-X.Y.Z.whl (for sistem-wide installation)
```
NOTE: due to cython+gcc behaviour we highly suggest to build python-efl using clang, it's twice faster and eat less ram. If you experience issues using gcc (like memory exhausted or strange compile errors) just use clang in this way:
@@ -38,13 +41,17 @@ NOTE: due to cython+gcc behaviour we highly suggest to build python-efl using cl
CC=clang python -m build
```
+To see more install options:
+```
+python -m pip install --help
+python -m build --help
+```
+
## Source repository
If you would like to contribute to Python-EFL and make changes to the Python-EFL code you need to build from **git**. Development take place in the **master** branch, while we backport bugfixes in the release branches. You will find a branch for each released version, branches are named as **python-efl-X.X**.
-To build from git you also need to have [Cython](https://cython.org/) installed.
-
### Main repository
https://git.enlightenment.org/bindings/python/python-efl.git/
@@ -56,6 +63,17 @@ not have a git account in the E repo, and thus improving collaboration.
Feel free to make pull requests on GitHub.
+## Requirements
+- Python 3.6 or higher (http://www.python.org/)
+- Cython 3 or higher (http://cython.org/)
+- EFL must be the same minor version of the bindings,
+ es. python-efl 1.24 need efl 1.24
+- To build the DOCS you will also need:
+ - python-sphinx
+ - [optional] graphviz
+- At least 4GB of free RAM to build to build
+
+
## Documentation
Documentation for the last stable release can be found [here](https://docs.enlightenment.org/python-efl/current/).
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
