Metadata-Version: 1.1
Name: django-select2-forms
Version: 1.1.0
Summary: Django form fields using the Select2 jQuery plugin
Home-page: https://github.com/theatlantic/django-select2-forms
Author: Frankie Dintino
Author-email: fdintino@theatlantic.com
License: UNKNOWN
Description: django-select2-forms
        ====================
        
        **django-select2-forms** is a project that makes available Django form fields that
        use the `Select2 javascript plugin <http://ivaynberg.github.io/select2/>`_. It was
        created by developers at `The Atlantic <http://www.theatlantic.com/>`_.
        
        Installation
        ------------
        
        The recommended way to install with pip::
        
            pip install django-select2-forms
        
        or, to install with pip `from source <https://github.com/theatlantic/django-select2-forms>`_::
        
            pip install -e git+git://github.com/theatlantic/django-select2-forms.git#egg=django-select2-forms
        
        If the source is already checked out, use setuptools::
        
            python setup.py develop
        
        Usage
        -----
        
        The simplest way to use ``django-select2-forms`` is to use ``select2.fields.ForeignKey`` and ``select2.fields.ManyToManyField`` in place of ``django.db.models.ForeignKey`` and ``django.db.models.ManyToManyField``, respectively. These fields extend their django equivalents and take the same arguments, along with extra optional keyword arguments.
        
        select2.fields.ForeignKey examples
        ..................................
        
        In the following two examples, an "entry" is associated with only one author. The example below does not use ajax, but instead performs autocomplete filtering on the client-side using the ``<option>`` elements (the labels of which are drawn from ``Author.__unicode__()``) in an html ``<select>``.
        
        ::
        
            class Author(models.Model):
                name = models.CharField(max_length=100)
        
                def __unicode__(self):
                    return self.name
        
            class Entry(models.Model):
                author = select2.fields.ForeignKey(Author,
                    overlay="Choose an author...")
        
        
        This more advanced example autocompletes via ajax using the ``Author.name`` field and limits the autocomplete search to ``Author.objects.filter(active=True)``
        
        ::
        
            class Author(models.Model):
                name = models.CharField(max_length=100)
                active = models.BooleanField()
        
            class Entry(models.Model):
                author = select2.fields.ForeignKey(Author,
                    limit_choices_to=models.Q(active=True),
                    ajax=True,
                    search_field='name',
                    overlay="Choose an author...",
                    js_options={
                        'quiet_millis': 200,
                    })
        
        
        select2.fields.ManyToManyField examples
        .......................................
        
        In the following basic example, entries can have more than one author. This
        example does not do author name lookup via ajax, but populates ``<option>`` elements in a ``<select>`` with ``Author.__unicode__()`` for labels.
        
        ::
        
            class Author(models.Model):
                name = models.CharField(max_length=100)
        
                def __unicode__(self):
                    return self.name
        
            class Entry(models.Model):
                authors = select2.fields.ManyToManyField(Author)
        
        
        The following "kitchen sink" example allows authors to be ordered, and uses ajax to autocomplete on two variants of an author's name.
        
        ::
        
            from django.db import models
            from django.db.models import Q
            import select2.fields
            import select2.models
        
            class Author(models.Model):
                name = models.CharField(max_length=100)
                alt_name = models.CharField(max_length=100, blank=True, null=True)
        
            class EntryAuthors(select2.models.SortableThroughModel):
                """
                A custom m2m through table, with a ``position`` field for sorting.
        
                This allows us to store and retrieve an ordered list of authors for an entry.
                """
                entry = models.ForeignKey('Entry')
                author = models.ForeignKey(Author)
                position = models.PositiveSmallIntegerField()
        
            class Entry(models.Model):
                categories = select2.fields.ManyToManyField(Author,
                    through='EntryAuthors',
                    ajax=True,
                    search_field=lambda q: Q(name__icontains=q) | Q(alt_name__icontains=q),
                    sort_field='position',
                    js_options={'quiet_millis': 200})
        
        API Documentation
        -----------------
        
        `Read API documentation on github <https://github.com/theatlantic/django-select2-forms#api-documentation>`_
        
        License
        -------
        
        The django code is licensed under the
        `Simplified BSD License <http://opensource.org/licenses/BSD-2-Clause>`_ and
        is copyright The Atlantic Media Company. View the `LICENSE <https://github.com/theatlantic/django-select2-forms/blob/master/LICENSE>`_ file under the
        root directory for complete license and copyright information.
        
        The Select2 javascript library included is licensed under the
        `Apache Software Foundation License Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_.
        View the file `select2/static/select2/select2/LICENSE <https://github.com/theatlantic/django-select2-forms/blob/master/select2/static/select2/select2/LICENSE>`_ for complete license
        and copyright information about the Select2 javascript library.
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Django
