dc

django-choices

Sanity to the django choices functionality.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

173

Maintenance

Last Commit

2mos ago

Contributors

23

Package

Dependencies

2

License

MIT

Categories

Readme

==============

Django-Choices

|build-status| |code-quality| |coverage| |docs| |black| |pypi| |python-versions| |django-versions|

Order and sanity for django model choices.

Django choices provides a declarative way of using the choices option on django fields. Read the full documentation_ on ReadTheDocs.

Note: Django 3.0 added enumeration types <https://docs.djangoproject.com/en/3.0/releases/3.0/#enumerations-for-model-field-choices>. This feature mostly replaces the need for Django-Choices. See also Adam Johnson's post on using them <https://adamj.eu/tech/2020/01/27/moving-to-django-3-field-choices-enumeration-types/>.


Installation

You can install via PyPi or direct from the github repo.

.. code-block:: bash

$ pip install django-choices

Basic Usage

To start you create a choices class. Then you point the choices property on your fields to the choices attribute of the new class. Django will be able to use the choices and you will be able to access the values by name. For example you can replace this:

.. code-block:: python

# In models.py
class Person(models.Model):
    # Choices
    PERSON_TYPE = (
        ("C", "Customer"),
        ("E", "Employee"),
        ("G", "Groundhog"),
    )
    # Fields
    name = models.CharField(max_length=32)
    type = models.CharField(max_length=1, choices=PERSON_TYPE)

With this:

.. code-block:: python

# In models.py
from djchoices import DjangoChoices, ChoiceItem

class Person(models.Model):
    # Choices
    class PersonType(DjangoChoices):
        customer = ChoiceItem("C")
        employee = ChoiceItem("E")
        groundhog = ChoiceItem("G")

    # Fields
    name = models.CharField(max_length=32)
    type = models.CharField(max_length=1, choices=PersonType.choices)

You can use this elsewhere like this:

.. code-block:: python

# Other code
Person.create(name="Phil", type=Person.PersonType.groundhog)

You can use them without value, and the label will be used as value:

.. code-block:: python

class Sample(DjangoChoices):
    option_a = ChoiceItem()
    option_b = ChoiceItem()

print(Sample.option_a)  # "option_a"

License

Licensed under the MIT License_.


Source Code

The source code can be found on github_.

.. |build-status| image:: https://github.com/bigjason/django-choices/actions/workflows/ci.yml/badge.svg :alt: Build status :target: https://github.com/bigjason/django-choices/actions/workflows/ci.yml

.. |code-quality| image:: https://github.com/bigjason/django-choices/actions//workflows/code_quality.yml/badge.svg :alt: Code quality checks :target: https://github.com/bigjason/django-choices/actions//workflows/code_quality.yml

.. |coverage| image:: https://codecov.io/gh/bigjason/django-choices/branch/master/graph/badge.svg?token=pcbBUCju0B :alt: Code coverage :target: https://codecov.io/gh/bigjason/django-choices

.. |docs| image:: https://readthedocs.org/projects/django-choices/badge/?version=latest :target: http://django-choices.readthedocs.io/en/latest/ :alt: Documentation Status

.. |pypi| image:: https://img.shields.io/pypi/v/django-choices.svg :target: https://pypi.python.org/pypi/django-choices

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-choices.svg

.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-choices.svg

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. _choices: https://docs.djangoproject.com/en/stable/ref/models/fields/#choices .. _MIT License: https://en.wikipedia.org/wiki/MIT_License .. _django: https://www.djangoproject.com/ .. _github: https://github.com/bigjason/django-choices .. _PyPi: https://pypi.org/project/django-choices/ .. _documentation: https://django-choices.readthedocs.io/en/latest/

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100