django-multiselectfield/README.rst

93 lines
2.5 KiB
ReStructuredText

django-multiselectfield
=======================
.. image:: https://travis-ci.org/goinnn/django-multiselectfield.png?branch=master
:target: https://travis-ci.org/goinnn/django-multiselectfield
.. image:: https://coveralls.io/repos/goinnn/django-multiselectfield/badge.png?branch=master
:target: https://coveralls.io/r/goinnn/django-multiselectfield
.. image:: https://badge.fury.io/py/django-multiselectfield.png
:target: https://badge.fury.io/py/django-multiselectfield
.. image:: https://pypip.in/d/django-multiselectfield/badge.png
:target: https://pypi.python.org/pypi/django-multiselectfield
A new model and form field. With this you can get a multiple select from a choices
This egg is inspired by this `snippet <http://djangosnippets.org/snippets/1200/>`_
Installation
============
In your models.py
-----------------
::
from multiselectfield import MultiSelectField
...
MY_CHOICES = (('item_key1', 'Item title 1.1'),
('item_key2', 'Item title 1.2'),
('item_key3', 'Item title 1.3'),
('item_key4', 'Item title 1.4'),
('item_key5', 'Item title 1.5'))
MY_CHOICES2 = ((1, 'Item title 2.1'),
(2, 'Item title 2.2'),
(3, 'Item title 2.3'),
(4, 'Item title 2.4'),
(5, 'Item title 2.5'))
class MyModel(models.Model):
.....
my_field = MultiSelectField(choices=MY_CHOICES)
my_field2 = MultiSelectField(choices=MY_CHOICES2,
max_choices=3,
max_length=3)
In your settings.py
-------------------
Only you need it, if you want the translation of django-multiselectfield
::
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.admin',
#.....................#
'multiselectfield',
)
Development
===========
You can get the last bleeding edge version of django-configfield by doing a clone
of its git repository::
git clone https://github.com/goinnn/django-multiselectfield
Example project
===============
In the source tree, you will find a directory called `example <https://github.com/goinnn/django-multiselectfield/tree/master/example/>`_. It contains
a readily setup project that uses django-multiselectfield. You can run it as usual:
::
python manage.py syncdb --noinput
python manage.py runserver