Metadata-Version: 2.4
Name: django-colorful
Version: 1.4.0
Summary: An extension to the Django web framework that provides database and form color fields
Author-email: Simon Charette <charette.s@gmail.com>
License: copyright (c) 2010 SIMON CHARETTE
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/charettes/django-colorful
Keywords: django,color,fields
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
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-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Dynamic: license-file

###############
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://github.com/charettes/django-colorful/workflows/Test/badge.svg
   :target: https://github.com/charettes/django-colorful/actions
   :alt: GitHub Actions

.. 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.

.. note:: 
    To enable HTML5 color input with `Django Grappelli`_ ensure that 
    ``GRAPPELLI_CLEAN_INPUT_TYPES`` is set to ``False`` in your settings file.

.. _Django Grappelli: https://github.com/sehmaschine/django-grappelli
