django-report-builder 7.0.0

Query and Report builder for Django ORM

django-report-builder

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

Status

Maintained and feature-complete. This project is no longer accepting new features — the scope is what's already shipped, and that's the project's strength: it does what it does, well, without churn.

Bug reports are welcome, especially when paired with a fix. Issues opened without a reproduction or proposed patch will likely sit. Please open them on GitLab.

For the version history, see CHANGELOG.

What is Django Report Builder?

A staff-facing UI that lets users:

• Pick a root model, drag in display fields, and traverse related models several levels deep
• Add filters with the full set of Django ORM lookup types (exact, gt, icontains, range, relative_range, isnull, regex, etc.)
• Preview results in the browser and export to xlsx or csv
• Optionally hand off long-running exports to a background task queue (Celery or django-tasks)
• Schedule reports to run on a recurring basis and email the results
• Trigger a report from a Django admin change-list as a global action

Report builder is intended for trusted staff users — access is gated on is_staff, and the standard Django change/view permissions control who can see existing reports.

Documentation

django-report-builder.readthedocs.io

Development quickstart

The repo ships a Django demo project plus the Angular SPA. The fastest path:

1. docker compose up — starts Postgres and the Django dev server on :8000
2. docker compose run --rm web ./manage.py migrate
3. docker compose run --rm web ./manage.py createsuperuser
4. cd js && npm install && npm start — Angular dev server with hot reload, proxying API requests to Django
5. Open http://localhost:8000/admin, log in, then visit the URL the Angular CLI prints (/report_builder on the dev-server port)

For deeper notes, see docs/contributors.md.

---

If your Django project needs error tracking or performance monitoring, take a look at GlitchTip — my open-source, Sentry-compatible error tracker.