Installing ReportBro

Install and initialize ReportBro Designer

Move the dist folder from the ReportBro Designer download into your application. To embed ReportBro in your web application you need to include the ReportBro JavaScript file as well as the ReportBro stylesheet in the <head> of your page.

<link rel="stylesheet" href="dist/reportbro.css"/>
<script src="dist/reportbro.js"></script>

Place an empty div within the <body> of a web page:

<div id="reportbro"></div>

Now you are ready to go and initialize ReportBro:

<script type="text/javascript">
    const rb = new ReportBro(document.getElementById('reportbro'), {});
</script>

For older versions of ReportBro Designer (pre v3.0) you also have to include jQuery and make sure to load jQuery before ReportBro's JavaScript. See how it's done

Install ReportBro Lib

The reportbro-lib package is a Python library to generate reports designed with ReportBro Designer. It can be installed on your Python webserver and integrated into your web application.

For open source and personal projects you may be just fine with using our publicly available ReportBro Server to generate your reports. Side effect is that the ReportBro logo will be displayed as a watermark image on the bottom of each page. Further you cannot add additional fonts and you have to pass all report parameters with your web request (this could be slow depending on the size of your data). We cannot guarantee availability of the server and response times may vary depending on the server load. Continue here if you want to run your own report server.

Installation Instructions

Install Python from Python Website
ReportBro supports Python 3.7+. If you do not have Python installed use the latest stable 3.x release.

Optional: install a virtual environment. As recommended for any Python project you should create a virtual environment to isolate your installed libraries from your Python system environment, see Creating virtual environments.

Create a virtual environment called env:

$ python3 -m venv env

Activate the virtual environment:

$ . env/bin/activate

On Windows the virtual environment is activated this way instead:

$ env\Scripts\activate

Once the virtual environment is activated you should see the environment name prepended to the shell prompt.

Install ReportBro Lib with Python Package Manager pip

$ pip install reportbro-lib

In case you are already using a Python webserver (e.g. Django, web2py, Flask, Bottle or Pyramid) you can directly integrate the reportbro-lib into your existing application. See the Demo-Apps in the Download section.

If you don't have an existing Python webserver check out our minimal report server implementation:

reportbro-server-tornado

This is a simple Python webserver using Tornado to generate reports with ReportBro.

Download on Github

Python

MIT