Source

django-selectable / docs / quick-start.rst

Full commit

Getting Started

The workflow for using django-selectable involves two main parts:
  • Defining your lookups
  • Defining your forms

This guide assumes that you have a basic knowledge of creating Django models and forms. If not you should first read through the documentation on defining models and using forms.

Defining a Lookup

The lookup classes define the backend views. The most common case is defining a lookup which searchs models based on a particular field. Let's define a simple model:

In a lookups.py we will define our lookup:

This lookups extends selectable.base.ModelLookup and defines two things: one is the model on which we will be searching and the other is the field which we are searching. This syntax should look familiar as it is the same as the field lookup syntax for making queries in Django.

Below this definition we will register our lookup class.

registry.register(FruitLookup)

Defining Forms

Now that we have a working lookup we will define a form which uses it:

This replaces the default widget for the CharField with the AutoCompleteWidget. This will allow the user to fill this field with values taken from the names of existing Fruit models.

And that's pretty much it. Keep on reading if you want to learn about the other types of fields and widgets that are available as well as defining more complicated lookups.