djangoql-iplweb 0.21.0

DjangoQL: Advanced search language for Django (iplweb fork with i18n)

DjangoQL

Advanced search language for Django, with auto-completion. Supports logical operators, parenthesis, table joins, and works with any Django model. Tested on Python 3.10–3.14, Django 5.2 and 6.0. The auto-completion feature has been tested in Chrome, Firefox, Safari, IE9+.

This is a community fork. djangoql-iplweb is a fork of the original DjangoQL by ivelum — install the upstream package from djangoql on PyPI. This fork adds internationalization (i18n) of error messages and modernized packaging/tooling.

These changes are offered back to the upstream project. If the original maintainers merge them, please switch back to the upstream djangoql package — this fork exists only to make the improvements available in the meantime, and will defer to upstream once they land there.

It is published on PyPI as djangoql-iplweb, but the import name stays djangoql (so INSTALLED_APPS and import djangoql are unchanged).

See a video: DjangoQL demo

Features

• Python-like query syntax: logical operators (and, or), parenthesis, and the full set of comparison operators
• Searches across model relations via joins, e.g. author.last_name = "Tolstoy"
• Works with any Django model and drops into the Django admin with a single mixin
• Live auto-completion of model field names and values in the admin
• Configurable schema to restrict searchable models/fields and provide suggestion options
• Custom search fields for annotations and fully custom search logic
• Internationalized error messages with translation catalogs for 11 locales
• Usable outside the Django admin, including a standalone JavaScript completion widget

Installation

Using uv (recommended):

$ uv add djangoql-iplweb

Using pip:

$ pip install djangoql-iplweb

Add 'djangoql' to INSTALLED_APPS in your settings.py:

INSTALLED_APPS = [
    ...
    'djangoql',
    ...
]

For full setup instructions and usage examples, see the Documentation below.

Documentation

📖 Full documentation: https://iplweb.github.io/djangoql-iplweb/

The site is built with MkDocs from the docs/ directory. Key pages:

• Installation — complete setup guide
• Django admin integration — DjangoQLSearchMixin and admin search modes
• Language reference — query syntax, operators, and examples
• Schema & custom fields — restrict searchable models/fields, custom search fields
• Derived fields — date/time parts, relation aggregates, custom search logic
• Outside the admin — DjangoQLQuerySet and apply_search()
• Completion widget — standalone JS widget outside the admin
• Internationalization — i18n support and supplied locales

Supported by

This fork is graciously supported and maintained by iplweb.

License

MIT