Installation#

PyJNIus depends on Cython and the Java Development Kit (includes the Java Runtime Environment).

Installation on GNU/Linux distributions#

You need the GNU Compiler Collection (GCC), the JDK and JRE installed (openjdk will do), and Cython. Then, just type:

sudo python setup.py install

If you want to compile the extension within the directory for any development, just type:

make

You can run the tests suite to make sure everything is running right:

make tests

Installation for Android#

To use pyjnius in an Android app, you must include it in your compiled Python distribution. This is done automatically if you build a Kivy app, but you can also add it to your requirements explicitly as follows.

If you use buildozer, add pyjnius to your requirements in buildozer.spec:

requirements = pyjnius

If you use python-for-android directly, add pyjnius to the requirements argument when creating a dist or apk:

p4a apk --requirements=pyjnius

Installation for Windows#

Python and pip must be installed and present in the PATH environment variable.

  1. Download and install the JDK containing the JRE:

    http://www.oracle.com/technetwork/java/javase/downloads/index.html

  2. Edit your system and environment variables (use the appropriate Java bitness and version in the paths):

    Add to your Environment Variables:

    • JAVA_HOME: C:\Program Files\Java\jdk1.7.0_79\bin

    • PATH: C:\Program Files\Java\jdk1.7.0_79\jre\bin\server contains the jvm.dll necessary for importing and using PyJNIus.

      Note

      set PATH=%PATH%;C:\Program Files\Java\jdk1.7.0_79\jre\bin\server

    Add to System Variables or have it present in your PATH:

    • PATH: C:\Program Files\Java\jdk1.7.0_79\bin`

  3. Download and install the C compiler:

    1. Microsoft Visual C++ Compiler for Python 2.7:

      http://aka.ms/vcpython27

    2. MinGWPy for Python 2.7:

      https://anaconda.org/carlkl/mingwpy

    3. Microsoft Visual C++ Build Tools (command-line tools subset of Visual Studio) for Python 3.5 and 3.6:

      https://visualstudio.microsoft.com/downloads/

    For other versions see Python’s Windows Compilers wiki.

  4. Update pip and setuptools:

    python -m pip install --upgrade pip setuptools

  5. Install Cython:

    python -m pip install --upgrade cython

  6. Install Pyjnius:

    pip install pyjnius

    Note

    In case of MinGWPy’s GCC returning a CreateProcess failed: 5 error you need to run the command prompt with elevated permissions, so that the compiler can access the JDK in C:\Program Files\Java\jdkx.y.z_b or C:\Program Files (x86)\Java\jdkx.y.z_b.

Installation for macOS#

Python and pip must be installed and present in the PATH environment variable.

  1. Download and install the JDK containing the JRE:

    http://www.oracle.com/technetwork/java/javase/downloads/index.html

  2. Edit your system and environment variables (use the appropriate Java bitness and version in the paths):

    Add to your Environment Variables:

    • export JAVA_HOME=/usr/libexec/java_home

  3. Install Xcode command-line tools.

  4. Update pip and setuptools:

    python -m pip install --upgrade pip setuptools

  5. Install Cython:

    python -m pip install --upgrade cython

  6. Install Pyjnius:

    pip install pyjnius

Installation for Conda#

Similar to PIP there is a package manager for Anaconda <https://www.anaconda.com/what-is-anaconda/> called Conda. An unofficial compiled distributions of PyJNIus for Conda supported platforms you can find at https://anaconda.org/conda-forge/pyjnius.

You can install pyjnius with this command:

conda install -c conda-forge pyjnius

Or if you want a specific package label e.g. gcc7:

conda install -c conda-forge/label/gcc7 pyjnius