PyReportJasper is available either as a pre-compiled binary for Anaconda and PYPI, or may be built from source though various methods.

Binary Install

PyReportJasper can be installed as pre-compiled binary if you are using the Anaconda Python stack. Binaries are available for Linux, OSX, and windows on conda-forge.

  1. Ensure you have installed Anaconda/Miniconda. Instructions can be found here.

  2. Install from the conda-forge software channel:

    conda install -c conda-forge pyreportjasper

Source Install

Installing from source requires:

PyReportJasper works CPython 3.5 or later. Both the runtime and the development package are required.
Either the Sun/Oracle JDK/JRE Variant or OpenJDK. PyReportJasper has been tested with Java versions from Java 1.9 to Java 15.
JPype is a Python module to provide full access to Java from within Python.

Once these requirements have been met, one can use pip to build from either the source distribution or directly from the repository. Specific requirements from different achitectures are listed below.

Build using pip

PyReportJasper may be built and installed with one step using pip.

To install the latest PyReportJasper, use:

pip install pyreportjasper

This will install PyReportJasper either from source or binary distribution, depending on your operating system and pip version.

To install from the current github master use:

pip install

More details on installing from git can be found at Pip install. The git version does not include a prebuilt jar the JDK is required.

Build and install manually

PyReportJasper can be built entirely from source.

1. Get the PyReportJasper source

The PyReportJasper source may be acquired from either github or from PyPi.

2. Build the source with desired options

Compile PyReportJasper using the included script:

python build

3. Test PyReportJasper with (optional):

python -m unittest discover ./test -p '*.py'

4. Install PyReportJasper with:

python install

If it fails…

Most failures happen when is unable to find the JDK home directory which shouble be set in the enviroment variable JAVA_HOME. If this happens, preform the following steps:

  1. Identify the location of your JDK systems installation and set the environment variable.

    export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64/
  2. If that still fails please create an Issue on github and post the relevant logs.

Platform Specific requirements

PyReportJasper is known to work on Linux, OSX, and Windows. To make it easier to those who have not built CPython modules before here are some helpful tips for different machines.


Debian/Ubuntu users will have to install g++ and python-dev. Use:

sudo apt-get install g++ python-dev python3-dev


CPython modules must be built with the same C++ compiler used to build Python. The tools listed below work for Python 3.5 to 3.9. Check with Python dev guide for the latest instructions.

  1. Install your desired version of Python (3.5 or higher), e.g., Miniconda is a good choice for users not yet familiar with the language
  2. For Python 3 series, Install either 2017 or 2019 Visual Studio. Microsoft Visual Studio 2019 Community Edition is known to work.

From the Python developer page:

When installing Visual Studio 2019, select the Python development workload and the optional Python native development tools component to obtain all of the necessary build tools. If you do not already have git installed, you can find git for Windows on the Individual components tab of the installer.

When building for windows you must use the Visual Studio developer command prompt.