Welcome to django-autocomplete-light’s documentation!

Features

This app fills all your ajax autocomplete needs:

  • global navigation autocomplete like on http://betspire.com
  • autocomplete widget for ModelChoiceField and ModelMultipleChoiceField
  • 0 hack required for admin integration, just use a form that uses the widget
  • no jQuery-ui required, the autocomplete script is as simple as possible
  • all the design of the autocompletes is encapsulated in template, unlimited design possibilities
  • 99% of the python logic is encapsulated in “channel” classes, unlimited development possibilities
  • 99% the javascript logic is encapsulated in a class, you can override any attribute or method, unlimited development possibilities
  • 0 inline javascript you can load the javascript just before </body> for best page loading performance
  • simple python, html and javascript, easy to hack, PEP8 compliant
  • less sucking code, no funny hacks, clean api, as few code as possible, that also means this is not for pushovers

README

https://secure.travis-ci.org/yourlabs/django-autocomplete-light.png?branch=master

This is a simple alternative to django-ajax-selects.

Requirements

Python 2.7 jQuery 1.7+ Django 1.4+ (at least for autocomplete_light.forms helpers) django.contrib.staticfiles or you’re on your own

Resources

Documentation graciously hosted by RTFD: http://django-autocomplete-light.rtfd.org

Continuous integration graciously hosted by Travis: http://travis-ci.org/yourlabs/django-autocomplete-light

Git graciously hosted by GitHub: https://github.com/yourlabs/django-autocomplete-light/

Package graciously hosted by PyPi: http://pypi.python.org/pypi/django-autocomplete-light/

Demo

See test_project/README

Javascript API

Work in progress:

When things go wrong

If you don’t know how to debug, you should learn to use:

Firebug javascript debugger
Open the script tab, select a script, click on the left of the code to place a breakpoint
Ipdb python debugger
Install ipdb with pip, and place in your python code: import ipdb; ipdb.set_trace()

If you are able to do that, then you are a professional, enjoy autocomplete_light !!!

If you need help, open an issue on the github issues page.

But make sure you’ve read how to report bugs effectively and how to ask smart questions.

Also, don’t hesitate to do pull requests !

Indices and tables

Project Versions

Table Of Contents

Next topic

django-autocomplete-light demo

This Page