Skip to content

Installation Guide

The current version is tested with Microsoft Windows and Unix/Linux based operating systems. PySiddhi can be installed using one of the following methods.

Install PySiddhi

Prerequisites

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

    Linux

    • Python 2.7 or 3.x
    • Cython
      sudo pip install cython
    • Python Developer Package
      sudo apt-get install python-dev python3-dev python-dev
    • Oracle Java 8 and set JAVA_HOME path
    • libboost for Python (Only to build from Source)
      sudo apt-get install libboost-python-dev
    • Maven (Only to build from Source)
    • g++ and other development tools (Only to build from Source)
      sudo apt-get install build-essential g++ autotools-dev libicu-dev build-essential libbz2-dev libboost-all-dev

    macOS

    • Install brew
    • Install python using brew
    • Cython
      sudo pip install cython
    • Oracle Java 8 and set JAVA_HOME path
    • boost for python (Only to build from Source)
      brew install boost
    • Maven (Only to build from Source)

    Windows

    • Install Python
    • Cython
      sudo pip install cython
    • Oracle Java 8 and set JAVA_HOME path
    • Install Visual Studio Build tools (Only to build from Source)
    • Maven (Only to build from Source)

  • Download siddhi-sdk release from here and set the SIDDHISDK_HOME as an environment variable.
    export SIDDHISDK_HOME="<path-to-siddhi-sdk>"

  • Download siddhi-python-api-proxy-5.0.0.jar from here and copy to <SIDDHISDK_HOME>/lib directory

Install PySiddhi via Python Package Management

PySiddhi can be installed via PIP command as bellow.

pip install pysiddhi

Install PySiddhi from Online Code

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

pip install git+https://github.com/siddhi-io/PySiddhi.git

Note: In case of permission errors, use sudo

Install from Downloaded Code

Switch to the branch master of PySiddhi. Navigate to source code root directory and execute the following PIP command.

pip install .

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

Uninstall PySiddhi

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

pip uninstall pysiddhi