/
README
77 lines (66 loc) · 3.22 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
.. image:: https://secure.travis-ci.org/yourlabs/django-autocomplete-light.png?branch=master
:target: http://travis-ci.org/yourlabs/django-autocomplete-light
.. image:: https://pypip.in/d/django-autocomplete-light/badge.png
:target: https://crate.io/packages/django-autocomplete-light
.. image:: https://pypip.in/v/django-autocomplete-light/badge.png
:target: https://crate.io/packages/django-autocomplete-light
.. image:: https://coveralls.io/repos/yourlabs/django-autocomplete-light/badge.png?branch=stable/2.x.x
:target: https://coveralls.io/r/yourlabs/django-autocomplete-light?branch=stable/2.x.x
django-autocomplete-light's purpose is to enable autocompletes quickly and
properly in a django project: it is the fruit of **years of R&D**. It was
designed for Django so that every part overridable or reusable independently.
It is stable, tested, documented and fully supported: it tries to be a good
neighbour in Django ecosystem.
Features
--------
Features include:
- charfield, foreign key, many to many autocomplete widgets,
- generic foreign key, generic many to many autocomplete widgets,
- django template engine support for autocompletes, enabling you to include
images etc ...
- 100% overridable HTML, CSS, Python and Javascript: there is no variable
hidden far down in the scope anywhere.
- add-another popup supported outside the admin too.
- keyboard is supported with enter, tab and arrows by default.
- Django 1.7, Python3 support
Each feature has a live example and is fully documented. It is also designed
and documented so that you create your own awesome features too.
Upgrade from 1.x.x
------------------
**To upgrade to v2**, please enjoy the `v1 to v2 upgrade instructions
<http://django-autocomplete-light.readthedocs.org/en/stable-2.x.x/1to2.html>`_
(documented with love !).
- the Autocomplete class design hasn't changed at all.
- ``yourlabsWidget()`` doesn't parses ``data-*`` options the same,
- the django/form python code has been re-organised ie.
``get_widgets_dict()`` is gone and ``autocomplete_light.ModelForm``
wraps around all features by default.
- use ``autocomplete_light.ModelForm`` instead of
``autocomplete_light.GenericModelForm`` - generic foreign keys and
django-generic-m2m are supported by default if installed.
Resources
---------
Resources include:
- `**Documentation** graciously hosted
<http://django-autocomplete-light.rtfd.org>`_ by `RTFD
<http://rtfd.org>`_
- `Live demo graciously hosted
<http://jpic.pythonanywhere.com/>`_ by `PythonAnywhere
<http://pythonanywhere.com/>`_,
- `Video demo graciously hosted
<http://youtu.be/fJIHiqWKUXI>`_ by `Youtube
<http://youtube.com>`_,
- `Mailing list graciously hosted
<http://groups.google.com/group/yourlabs>`_ by `Google
<http://groups.google.com>`_
- `Git graciously hosted
<https://github.com/yourlabs/django-autocomplete-light/>`_ by `GitHub
<http://github.com>`_,
- `Package graciously hosted
<http://pypi.python.org/pypi/django-autocomplete-light/>`_ by `PyPi
<http://pypi.python.org/pypi>`_,
- `Continuous integration graciously hosted
<http://travis-ci.org/yourlabs/django-autocomplete-light>`_ by `Travis-ci
<http://travis-ci.org>`_
- `**Online paid support** provided via HackHands
<https://hackhands.com/jpic/>`_,