django-colorfield 0.5.0

simple color field for your models with a nice color-picker in the admin-interface.

django-colorfield

simple color field for your models with a nice color-picker in the admin-interface.

Installation

• Run pip install django-colorfield
• Add colorfield to settings.INSTALLED_APPS
• Run python manage.py collectstatic
• Restart your application server

Usage

Settings

This package doesn't need any setting.

Models

Just add color field(s) to your models like this:

from colorfield.fields import ColorField
from django.db import models

class MyModel(model.Model):
    color = ColorField(default='#FF0000')

Color Format

ColorField defaults to HEX format but also support HEXA. To set the format:

from colorfield.fields import ColorField
from django.db import models

class MyModel(model.Model):
    color = ColorField(format='hexa')

Color Palette

It is possible to provide a palette to choose from to the widget. It can be done by using the field choices (force to choose from choices) or samples (just like choices, but allows also custom color selection).

from colorfield.fields import ColorField
from django.db import models

class MyModel(model.Model):

    COLOR_CHOICES = [
        ("#FFFFFF", "white"),
        ("#000000", "black")
    ]

    # restrictive
    color = ColorField(choices=COLOR_CHOICES)

    # not restrictive
    color = ColorField(samples=COLOR_CHOICES)

Admin

The admin will kindly provide a simple color picker for all color fields. :)

Testing

# create python virtual environment
virtualenv testing_django_colorfield

# activate virtualenv
cd testing_django_colorfield && . bin/activate

# clone repo
git clone https://github.com/fabiocaccamo/django-colorfield.git src && cd src

# install dev requirements
pip install -r requirements.txt

# run tests
tox
# or
python setup.py test
# or
python -m django test --settings "tests.settings"

Credits

Originally developed by Jared Forsyth

License

Released under MIT License.

---

See also

• django-admin-interface - the default admin interface made customizable by the admin itself. popup windows replaced by modals. 🧙 ⚡

• django-extra-settings - config and manage typed extra settings using just the django admin. ⚙️

• django-maintenance-mode - shows a 503 error page when maintenance-mode is on. 🚧 🛠️

• django-redirects - redirects with full control. ↪️

• django-treenode - probably the best abstract model / admin for your tree based stuff. 🌳

• python-benedict - dict subclass with keylist/keypath support, I/O shortcuts (base64, csv, json, pickle, plist, query-string, toml, xml, yaml) and many utilities. 📘

• python-codicefiscale - encode/decode Italian fiscal codes - codifica/decodifica del Codice Fiscale. 🇮🇹 💳

• python-fontbro - friendly font operations. 🧢

• python-fsutil - file-system utilities for lazy devs. 🧟‍♂️