django report builder

This is a github mirror for django-report-builder which is hosted on Gitlab. Django Report Builder is a GUI for Django ORM. Build custom queries and display results. Targets sys admins and capable end users who might not be able to program.

burke-software
768
268
Python

django-report-builder

A GUI for Django ORM. Build custom queries and display results.
Targets sys admins and capable end users who might not be able to program or gain direct interactive shell access.

pipeline status
coverage report

Call for Sponsorship

Donate using Liberapay

Are you a fan of Report Builder or using it at your workplace? Please consider sponsorship. You may donate on Liberapay directly or contact me about sponsoring a feature. Right now, we need better documentation. Get your profile or company logo added to our Readme as a sponsor. Paid commercial support is also available. Email [email protected] for more infomation.

News

6.4.2

  • Fixes to CI pipeline

6.4

  • Added Django 3.0 and 3.1 support. Django 1.11 and 2.2 are still supported. This will likely be the last release to support 1.11.

6.3.2

  • Fixed admin widgets (Thanks predatell)
  • Angular updated to version 8

6.3

  • Added Django 2.2 support. Django 1.11 and 2.1 are still supported.
  • Unit tests finally run in Python 3.7 thanks to Celery supporting it
  • Angular updated to version 7

View more on the CHANGELOG.

What is Django Report Builder?

Features

  • Add filters
  • Add display fields
  • Preview and create xlsx reports
  • Uses Django permissions models - Staff users must have “change” or “view” permission to view
    reports. Unprivileged users can still build reports and see database schema.
    • Report builder is intended for generally trusted staff users and requires is_staff to be set.
  • Export to Report global admin action
  • Scheduled reports can generate and send to users on cron like schedule
  • Optional asynchronous report generation

Documentation

http://django-report-builder.readthedocs.org/

Google group.

Contributing

Development quick start

This package uses Django in Docker and Angular CLI for development purposes.

  1. Start docker docker-compose up
  2. Migrate and create an admin user docker-compose run --rm web ./manage.py migrate
  3. Start the Angular CLI server. Ensure Node is installed. cd js, yarn, yarn start
  4. Django runs on port 8000 by default. Go to localhost:8000/admin and log in.
  5. Angular runs on port 4200. Now that you are logged in, go to localhost:4200

More detailed instructions are at here