Installation Guide

PySiddhi can be installed as a Python Library from Source Code. No binary releases are available as of now.

Prerequisites

The current version is tested with Microsoft Windows and Unix/Linux based operating systems.

The following dependencies should be installed prior to installation of library.

• Python 2.7 or 3.x (Python 3.5+ recommended)
• Cython (sudo apt-get install cython)
• Python Developer Package (sudo apt-get install python-dev python3-dev)
• Pyjnius (sudo pip install pyjnius)
• Future (sudo pip install future)
• PIP Package Manager for Python (for installation)
• Java 8.0 and Maven (maven is required for installation from source)
• libboost for Python (sudo apt-get install libboost-python-dev)
• g++ and other development tools
  • sudo apt-get install build-essential g++ autotools-dev libicu-dev build-essential libbz2-dev libboost-all-dev
• Requests (sudo apt-get install requests for PySiddhi4 only)
• For use of WSO2 DAS 4.0 Client functionality, it is required to have WSO2 DAS 4.0 installed and running.
  • Obtain WSO2 DAS 4.0-M6 binary distribution from https://github.com/wso2/product-das/releases/tag/v4.0.0-M6.
  • Extract wso2das-4.0.0-SNAPSHOT.zip to a suitable location (say DAS_HOME).
  • Navigate to DAS_Home/bin/ and run sh worker.sh.

Installation

This is the easiest method to install PySiddhi to quickly try-out its features. Alternatively, you may download the source code and install from local copy if you are looking forward to contribute to the code.

Before installation, make sure all the prerequisites (dependencies) are resolved.

Install PySiddhi4 from Online Code

Using the following PIP command, PySiddhi4 can be directly installed from online code available in GitHub.

pip install git+https://github.com/wso2/PySiddhi.git

Note: In case of permission errors, use sudo

Install PySiddhi3 from Online Code

Using the following PIP command, PySiddhi3 can be directly installed from online code available in GitHub.

pip install git+https://github.com/wso2/PySiddhi.git@3.x

Note: In case of permission errors, use sudo

Install from Downloaded Code

Switch to the branch master for PySiddhi4. Alternatively, switch to branch 3.x for PySiddhi3.

Navigate to source code root and execute the following PIP command.

pip install .

Note the period (.) at end of command. In case of permission errors, use sudo

Uninstall

If the library has been installed as explained above, it could be uninstalled using the following pip command.

pip uninstall pysiddhi3
pip uninstall pysiddhi4