Metadata-Version: 2.0
Name: django-colorful
Version: 1.2
Summary: An extension to the Django web framework that provides database and form color fields
Home-page: https://github.com/charettes/django-colorful
Author: Simon Charette
Author-email: charette.s@gmail.com
License: MIT License
Keywords: django color field
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Django (>=1.8)

###############
django-colorful
###############

An extension to the Django web framework that provides a database and form
field to accept and store colors in the RGB format.

.. image:: https://travis-ci.org/charettes/django-colorful.svg?branch=master
    :target: https://travis-ci.org/charettes/django-colorful

.. image:: https://coveralls.io/repos/charettes/django-colorful/badge.svg?branch=master&service=github
    :target: https://coveralls.io/github/charettes/django-colorful?branch=master

************
Installation
************

>>> pip install django-colorful

Make sure ``'colorful'`` is in your `INSTALLED_APPS`:

::

    INSTALLED_APPS.append('colorful')

*****
Usage
*****

In order to use a color field you just have to add it to your model definition:

::

    from django.db import models
    from colorful.fields import RGBColorField

    class Tag(models.Model):
        color = RGBColorField()

The ``RGBColorField`` class also accepts a ``color`` keyword argument which can
be set to a list of colors that should be visible as preset color palette:

::

    color = RGBColorField(colors=['#FF0000', '#00FF00', '#0000FF'])

The ``ColorFieldWidget`` should take care of providing a JavaScript based shim
on browsers that don't support the HTML5 color input .


