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
- autocompletes that depend on each other, working example provided
- GenericForeignKey fully supported
- django-generic-m2m support, yes that’s a generic M2M relation!
- APIs powered autocomplete support, proposing results that are not (yet) in the database
- very few code was required to implement this kind of features , this app lets you satisfy the craziest autocomplete ideas your users might want, in a maintainable and sane way,
- 0 hack required for admin integration, just use a form that uses the widget. It works exactly the same in the admin and in your pages.
- 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 server side development possibilities
- 99% the javascript logic is encapsulated in an object, you can override any attribute or method, unlimited client side development possibilities
- 0 inline javascript you can load the javascript just before </body> for best page loading performance, wherever you want
- 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
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¶
You could subscribe to the mailing list ask questions or just be informed of package updates.
Demo¶
See test_project/README
Full documentation¶
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 !