https://github.com/burke-software/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.
https://github.com/burke-software/django-report-builder
Last synced: about 1 month ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/burke-software/django-report-builder
- Owner: burke-software
- License: other
- Created: 2012-11-04T21:47:57.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T18:27:03.000Z (9 months ago)
- Last Synced: 2025-03-22T15:49:39.141Z (about 2 months ago)
- Language: Python
- Homepage: https://gitlab.com/burke-software/django-report-builder
- Size: 11 MB
- Stars: 768
- Watchers: 56
- Forks: 270
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - 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. (Python)
README
# 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.
[](https://gitlab.com/burke-software/django-report-builder/commits/master)
[](https://gitlab.com/burke-software/django-report-builder/commits/master)
# Call for Sponsorship
Are you a fan of Report Builder or using it at your workplace? Please consider sponsorship. You may donate on [Liberapay](https://liberapay.com/burke-software/donate) 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](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](https://groups.google.com/forum/#!forum/django-report-builder/).
[Contributing](http://django-report-builder.readthedocs.org/en/latest/contributors/)
## 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](https://django-report-builder.readthedocs.io/en/latest/contributors/)