Skip to main content

Query and Report builder for Django ORM

Project description

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.

pipeline status

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.docs.burkesoftware.com

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_report_builder-7.1.0.tar.gz (198.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_report_builder-7.1.0-py3-none-any.whl (210.0 kB view details)

Uploaded Python 3

File details

Details for the file django_report_builder-7.1.0.tar.gz.

File metadata

  • Download URL: django_report_builder-7.1.0.tar.gz
  • Upload date:
  • Size: 198.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for django_report_builder-7.1.0.tar.gz
Algorithm Hash digest
SHA256 8a1f7841abe198540f268f862472a40fb8e1b8870a077479249ed9b948cae8c9
MD5 ce0a63a7d9a084faff9335dee1137475
BLAKE2b-256 e771805b37fc326fa328cb0a3bdbb3aea8caf8b6a99c5f65046c2ccb41ea69e9

See more details on using hashes here.

File details

Details for the file django_report_builder-7.1.0-py3-none-any.whl.

File metadata

  • Download URL: django_report_builder-7.1.0-py3-none-any.whl
  • Upload date:
  • Size: 210.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for django_report_builder-7.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4dfc0569b23cd33e3950e94e9c82d9bcfa593dea3da27972edc88532839604b9
MD5 7323180ce827afc1c39ed609d0e9fb31
BLAKE2b-256 2982f6d3b8b074e7995ac7ef49b314e89682c4494f86a95d0405d1f7c4bae7ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page