django-search-queryΒΆ

A Lucene-inspired search query language that compiles to Django Q objects.

Tutorial

Build a search registry and run a query against a Django queryset.

Tutorial
How-to

Task recipes: map field names, restrict searchable fields, use wildcards and ranges, and catch parse errors.

How-to guides
Query language

The search syntax and the query-string-to-queryset showcase.

Query language
API reference

The public API: parse, build_q, search_query_to_q, the field registry.

API reference
Explanation

How a search string becomes a Q object, and why the highlighter uses a second lexer.

Explanation