Source

django-selectable / README.rst

Full commit
Mark Lavin 4aa2810 
Mark Lavin 68498d3 
Mark Lavin 4aa2810 


Mark Lavin a0e68c6 






Mark Lavin b830da2 

Mark Lavin 9d370fb 
Mark Lavin f9ab881 

Mark Lavin 7c56eae 
Mark Lavin 9d370fb 
Mark Lavin b830da2 
Mark Lavin f9ab881 




Mark Lavin 1b67d3e 

Mark Lavin a0e68c6 
Mark Lavin 1b67d3e 
Mark Lavin a0e68c6 
Mark Lavin b830da2 
Mark Lavin f9ab881 






Mark Lavin a0e68c6 
Mark Lavin 0170155 
Mark Lavin a0e68c6 


Mark Lavin 08be242 

Mark Lavin f9ab881 



Mark Lavin 08be242 
Mark Lavin db76762 
Mark Lavin 7484693 


Mark Lavin 810af7f 
Mark Lavin b6f7d93 
Mark Lavin 7484693 
Mark Lavin f4d2db5 




Mark Lavin 7484693 
Mark Lavin db76762 



Mark Lavin dc0f35e 
Mark Lavin db76762 
Mark Lavin 12188fd 

django-selectable
===================

Tools and widgets for using/creating auto-complete selection widgets using Django and jQuery UI.

Features
-----------------------------------

- Works with the latest jQuery UI Autocomplete library
- Auto-discovery/registration pattern for defining lookups


Installation Requirements
-----------------------------------

- Python 2.6 or Python 2.7
- `Django <http://www.djangoproject.com/>`_ >= 1.3
- `jQuery <http://jquery.com/>`_ >= 1.4.4
- `jQuery UI <http://jqueryui.com/>`_ >= 1.8

.. note::

    Begining with version django-selectable version 0.6, Django 1.2 is no longer supported.
    While it may continue to work, bugs related to Django 1.2 support will not be fixed.

    Version 0.7 adds experimental support for Python 3.2+ when used with Django 1.5+.

To install::

    pip install django-selectable

Next add `selectable` to your `INSTALLED_APPS` to include the related css/js::

    INSTALLED_APPS = (
        'contrib.staticfiles',
        # Other apps here
        'selectable',
    )

The jQuery and jQuery UI libraries are not included in the distribution but must be included
in your templates. See the example project for an example using these libraries from the
Google CDN.

Once installed you should add the urls to your root url patterns::

    urlpatterns = patterns('',
        # Other patterns go here
        (r'^selectable/', include('selectable.urls')),
    )


Documentation
-----------------------------------

Documentation for django-selectable is available on `Read The Docs <http://readthedocs.org/docs/django-selectable>`_.


Additional Help/Support
-----------------------------------

You can find additional help or support on the mailing list: http://groups.google.com/group/django-selectable


Contributing
--------------------------------------

If you think you've found a bug or are interested in contributing to this project
check out our `contributing guide <http://readthedocs.org/docs/django-selectable/en/latest/contribute.html>`_.

If you are interested in translating django-selectable into your native language
you can join the `Transifex project <https://www.transifex.com/projects/p/django-selectable/>`_.