Skip to main content

Frontend-agnostic Django autocomplete utilities

Project description

https://travis-ci.org/novafloss/django-agnocomplete.svg?branch=master

Heavily based on django-autocomplete-light v2 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.

Status

Beta, used in production.

Install

$ pip install django-agnocomplete

Or add django-agnocomplete to your project requirements.

Documentation

The full documentation is browsable on RTFD

Tests

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.4, 3.5.

  • Django 1.8, 1.9, 1.10.

and a flake8 check.

Are you a developer?

To target a specific test case, use the following:

$ tox -e py27-django18 --  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

Run the demo

The (draft) demo site can be browsed using the Django devserver. Run:

$ make 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.

Troubles running the demo?

This demo project is not build as a production-ready application, models can change, but there’s no migration in it. If you have database errors, you can try to remove it using:

$ make clean-db

Or, for more radical cleanup:

$ make clean-all

License

This piece of software is being published under the terms of the MIT License. Please read the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-agnocomplete-0.8.0.tar.gz (37.1 kB view hashes)

Uploaded Source

Built Distributions

django_agnocomplete-0.8.0-py2-none-any.whl (16.3 kB view hashes)

Uploaded Python 2

django-agnocomplete-0.8.0.linux-x86_64.tar.gz (26.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page