Heavily based on django-autocomplete-light workflow and concepts, this toolkit offers a front-end agnostic way to get fields for autocompletion.
It will provide:
- a simple and configurable entry-point management,
- a REST-like HTTP API to search for results,
- Fields and widgets that will make the interface between our Django code and your Javascript.
Under construction. Warning, fresh paint.
pip install django-agnocomplete
Or add django-agnocomplete
to your project requirements.
The full documentation is browsable on RTFD
Install tox
in your environment (it could be a virtualenv) and run:
tox
It'll run the tests for all the combinations of the following:
- Python 2.7, 3.3, 3.4
- Django 1.6, 1.7, 1.8
and a flake8
check.
To target a specific test case, use the following:
tox -e py27-django17 -- demo.tests.test_core.AutocompleteChoicesPagesOverrideTest
Everything after the double-dash will be passed to the django-admin.py test command.
If you need to install a debugger (let's say ipdb), you can use the TOX_EXTRA
environment variable like this:
TOX_EXTRA=ipdb tox -e py27-django18
The (draft) demo site can be browsed using the Django devserver. Run:
tox -e serve
It will run a syncdb (it may ask you questions) and then a runserver with your current demo.settings
. You can browse the (very rough) website at http://127.0.0.1:8000/. You can add any runserver options you want using the tox positional parameters, like this:
tox -e serve -- 9090 # to change the listening port
Here you'll be able to see that django-agnocomplete
has been easily and rapidly integrated with selectize.js
, select2
, jquery-autocomplete
and typeahead
. With the same backend, you can plug the JS front-end you want.
This piece of software is being published under the terms of the MIT License. Please read the LICENSE file for more details.