Django QBE 2

Build reports without writing SQL: choose columns, add typed conditions or summary calculations, preview pages and download CSV or optional Excel workbooks. Django QBE 2 is a reusable app for Python 3.13–3.14 and Django 6.0–6.1, inspired by versae/qbe.

Note

Version 1.0.0 is the first stable release. The public registration API is documented in Public registration API; compatibility follows the project’s supported Python and Django versions and the release notes.

Start with Try the demo to try the synthetic demo, or Install in your project to add the app to an existing project. Read Reports and permissions before exposing real data: Django model permissions and each report’s row policy are both required.

User guide

• Try the demo
  • Prepare the checkout
  • Build a report
  • Next steps
• Install in your project
  • Requirements
  • Install Django QBE 2
  • Configure Django
  • Register your models
• Reports and permissions
  • Explicit registration
  • Three authorization boundaries
  • QuerySet contract
  • Relationship paths
  • Example: subscriptions, users and pets
• Build and export queries
  • Supported values
  • Model choices and labels
  • Visual relationship explorer
  • Pagination and ordering
  • CSV behavior
  • Excel export
  • Query definition v1
  • Condition groups and definition v2
  • Summary reports and definition v3
• Saved queries and sharing
  • Set up storage
  • Find your queries
  • Save and reuse a definition
  • Share with named users
  • Changed permissions or configuration
  • Bounds
  • Grouped and summary definitions
• Scheduled reports
  • Create a schedule
  • Migration and storage
  • Run the scheduler
  • Email configuration
  • Recurrence and timezone behavior
  • Authorization and output limits
  • Troubleshooting
• Settings and HTTP routes
  • Report budgets
  • Namespaced routes
  • Authentication and errors
  • Scheduled report limits
  • Scheduled routes
• Troubleshooting
  • No reports available
  • The report is empty although Admin shows rows
  • Preview returns a generic error
  • A row disappears when I add a related column
  • System checks fail
  • Login or static assets do not work
  • A filter is rejected
  • Report or CSV is incomplete
  • SQLite Decimal summaries
  • Unsupported behavior

Developer guide

• Public registration API
  • Report
  • register()
  • get_reports()
• Contributing and documentation
  • Issue reports
  • Install development tools
  • Compatibility matrix
  • PostgreSQL tests
  • Build the documentation
  • Browser checks
  • Keep local state out of Git
• Release status and publication
  • Current status
  • Configure Trusted Publishing
  • Publish to TestPyPI first
  • Promote the verified files to PyPI
  • Repository and documentation publication
  • References
• Feature roadmap
  • Completed increments
  • Release readiness
  • Ideas requiring separate design
• Related model paths
  • Goal and compatibility
  • Path contract
  • Rows and filters
  • Bounds and failure behavior
  • Verification

Sources are plain reStructuredText under docs/source/. Developers and agents can read them directly from the repository without running the demo. Sphinx also produces HTML with search and plain-text output; see Contributing and documentation.

The code is licensed under MIT. This is a new implementation rather than a migration of the original package. Preserve upstream notices when reusing code.