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.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.

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.0.1.tar.gz (197.6 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.0.1-py3-none-any.whl (208.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_report_builder-7.0.1.tar.gz
  • Upload date:
  • Size: 197.6 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.0.1.tar.gz
Algorithm Hash digest
SHA256 a9a3fb26c5ca99350fde6fadcc727d141ff15627860e7c38d4b34e6139de2f59
MD5 a1f4942d566cbfc4e661de88e9f540c8
BLAKE2b-256 9cc8a0309c0e33efad83f2e59a1d05be1fb16c8a5586a65d1f1abbcf2956fd16

See more details on using hashes here.

File details

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

File metadata

  • Download URL: django_report_builder-7.0.1-py3-none-any.whl
  • Upload date:
  • Size: 208.7 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 95000387a1706f48e155c6e6cafb64b02fbbdbc9634618a2665cd55a75716ef9
MD5 3376aee9b7aa3132135f14574d7791aa
BLAKE2b-256 80c15f499ac3857406e08fcf3f0c83dc5c06f6f3b07547421960e92908091640

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