django-multiselectfield/README.rst

94 lines
2.5 KiB
ReStructuredText
Raw Normal View History

2012-09-27 12:08:07 +00:00
django-multiselectfield
=======================
2013-11-26 18:22:24 +00:00
.. 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
2013-09-11 08:51:10 +00:00
.. 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
2012-09-27 14:03:17 +00:00
A new model and form field. With this you can get a multiple select from a choices
2013-11-26 18:22:51 +00:00
This egg is inspired by this `snippet <http://djangosnippets.org/snippets/1200/>`_
2012-09-27 14:03:17 +00:00
Installation
============
In your models.py
-----------------
::
from multiselectfield import MultiSelectField
...
2013-11-26 18:03:02 +00:00
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'))
2012-09-27 14:03:17 +00:00
class MyModel(models.Model):
.....
2013-11-26 18:03:02 +00:00
my_field = MultiSelectField(choices=MY_CHOICES)
my_field2 = MultiSelectField(choices=MY_CHOICES2,
max_choices=3,
max_length=3)
2012-09-27 14:03:17 +00:00
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',
)
2012-09-27 14:03:17 +00:00
Development
===========
You can get the last bleeding edge version of django-configfield by doing a clone
of its git repository::
2012-09-27 14:03:17 +00:00
git clone https://github.com/goinnn/django-multiselectfield
2013-11-30 19:19:05 +00:00
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