Hopiu/django-select2
1
0
Fork 0
mirror of https://github.com/Hopiu/django-select2.git synced 2026-03-16 21:40:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
This is a Django integration for Select2
509 commits 3 branches 55 tags 8.1 MiB
Python 96.9%
JavaScript 2.4%
HTML 0.7%
Find a file
Benbb96 e7fa49a6e2
Prevent literal "None" placeholders (#591)
2020-02-25 11:50:21 +01:00
.github Create FUNDING.yml 2019-10-30 10:09:30 +09:00
django_select2 Prevent literal "None" placeholders (#591) 2020-02-25 11:50:21 +01:00
docs Improve getting started documentation (#542) 2019-12-13 14:52:03 +01:00
tests Prevent literal "None" placeholders (#591) 2020-02-25 11:50:21 +01:00
.bandit Add bandit config 2018-05-07 18:52:17 +02:00
.editorconfig Simplify package setup 2019-04-08 19:57:22 +02:00
.fussyfox.yml Simplify package setup 2019-04-08 19:57:22 +02:00
.gitignore Fix #535 -- Add static files to dist package 2019-04-10 11:58:40 +02:00
.travis.yml Add support for Django 3.0 2020-01-05 17:23:31 +01:00
CONTRIBUTING.rst Improve getting started documentation (#542) 2019-12-13 14:52:03 +01:00
LICENSE Simplify package setup 2019-04-08 19:57:22 +02:00
MANIFEST.in Fix #550 -- Omit tests from wheel 2019-06-10 18:03:23 +02:00
package.json Update travis-contif 2019-03-23 13:57:13 +01:00
README.rst Add note about Select2 support in Django 2.0 admin (#488) 2018-07-01 10:37:30 +02:00
set_version.py Fix automated NPM deployment process (#505) 2018-08-23 18:59:21 +02:00
setup.cfg Add support for Django 3.0 2020-01-05 17:23:31 +01:00
setup.py Add name to setup.py to enable GH dependency graph 2019-10-29 11:30:12 +09:00

README.rst 

Django-Select2
==============

|version| |ci| |coverage| |license|

This is a `Django`_ integration of `Select2`_.

The app includes Select2 driven Django Widgets.

.. note::
    Django's admin comes with builtin support for Select2
    since version 2.0 via the `autocomplete_fields`_ feature.

Installation
------------

1. Install ``django_select2``

.. code:: python

    pip install django_select2

2. Add ``django_select2`` to your ``INSTALLED_APPS`` in your project
   settings.

3. Add ``django_select`` to your urlconf if you use any "Auto" fields.

.. code:: python

    url(r'^select2/', include('django_select2.urls')),

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

Documentation available at http://django-select2.readthedocs.io/.

External Dependencies
---------------------

-  jQuery version 2 This is not included in the package since it is
   expected that in most scenarios this would already be available.

Example Application
-------------------

Please see ``tests/testapp`` application. This application is used to
manually test the functionalities of this package. This also serves as a
good example.

Changelog
---------

See `Github releases`_


.. _Django: https://www.djangoproject.com/
.. _Select2: http://ivaynberg.github.com/select2/
.. _autocomplete_fields: https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.ModelAdmin.autocomplete_fields
.. _CHANGELOG.md: CHANGELOG.md
.. _Github releases: https://github.com/applegrew/django-select2/releases

.. |version| image:: https://img.shields.io/pypi/v/Django-Select2.svg
   :target: https://pypi.python.org/pypi/Django-Select2/
.. |ci| image:: https://travis-ci.org/applegrew/django-select2.svg?branch=master
   :target: https://travis-ci.org/applegrew/django-select2
.. |coverage| image:: https://codecov.io/gh/applegrew/django-select2/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/applegrew/django-select2
.. |license| image:: https://img.shields.io/badge/license-APL2-blue.svg
   :target: https://raw.githubusercontent.com/applegrew/django-select2/master/LICENSE.txt