getting_started.rst

Getting Started

Installation

Install with pip:

pip install wagtail-autocomplete

Setup

Add 'wagtailautocomplete' to your project's INSTALLED_APPS.

Add Wagtail Autocomplete's URL patterns to your project's URL config, usually in urls.py. This should come before your wagtail_urls and if you are using the suggested pattern r'^admin/autocomplete/' it must also come before your admin urls:

from django.conf.urls import include, url

from wagtail.wagtailcore import urls as wagtail_urls

from wagtailautocomplete.urls.admin import urlpatterns as autocomplete_admin_urls

urlpatterns = [
    # ...
    url(r'^admin/autocomplete/', include(autocomplete_admin_urls)),
    url(r'^admin/', include(wagtailadmin_urls)),
    # ...
    url(r'', include(wagtail_urls)),
]

This makes available custom API endpoints that provide the search and creation behavior for the widget.

Continue to :doc:`Basic Usage <basic_usage>` to learn how to use the AutocompletePanel on a field in the admin.