Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peopledoc/django-agnocomplete
A front-end agnostic toolbox for autocompletion fields
https://github.com/peopledoc/django-agnocomplete
approved-public ghec-mig-migrated tribe-python
Last synced: 2 days ago
JSON representation
A front-end agnostic toolbox for autocompletion fields
- Host: GitHub
- URL: https://github.com/peopledoc/django-agnocomplete
- Owner: peopledoc
- License: mit
- Created: 2015-09-04T07:14:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T10:07:48.000Z (5 months ago)
- Last Synced: 2025-01-02T00:08:09.175Z (10 days ago)
- Topics: approved-public, ghec-mig-migrated, tribe-python
- Language: Python
- Homepage: http://django-agnocomplete.readthedocs.org/
- Size: 781 KB
- Stars: 19
- Watchers: 12
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- starred-awesome - django-agnocomplete - A front-end agnostic toolbox for autocompletion fields (Python)
README
============================
Django Agnostic Autocomplete
============================
.. image:: https://travis-ci.org/peopledoc/django-agnocomplete.svg?branch=master
:target: https://travis-ci.org/peopledoc/django-agnocomplete
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
======
Stable, used in production.
Install
=======
.. code:: sh
$ pip install django-agnocomplete
Or add ``django-agnocomplete`` to your project requirements.
Documentation
=============
`The full documentation is browsable on Read the Docs `_
Tests
=====
Install ``tox`` in your environment (it could be a virtualenv) and run:
.. code:: sh
$ tox
It'll run the tests for all the combinations of the following:
* Python 3.6, 3.7, 3.8, 3.9.
* Django 2.2.
and a ``flake8`` check.
Are you a developer?
--------------------
To target a specific test case, use the following:
.. code:: sh
$ tox -e py37-django22 -- 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:
.. code:: sh
$ TOX_EXTRA=ipdb tox -e py36-django22
.. note::
We've got a self documented Makefile for common tasks, such as running the tests, building the docs, etc.
Run the demo
============
The (draft) demo site can be browsed using the Django devserver. Run:
.. code:: sh
$ 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:
.. code:: sh
$ 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:
.. code:: sh
$ make clean-db
Or, for more radical cleanup:
.. code:: sh
$ 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.