README

Django Colors
=============

Author: Maxime Haineault (max@motion-m.ca)

http://motion-m.ca/projets/django-colors/
http://code.google.com/p/django-colors/


Introduction
============

Django colors is a small django app that we created to make our life easier while designing websites with the Django framework.

The app consist of a set of template filters which can manipulate hexadecimal colors. For example, you can easily increase or decrease the lightness or the saturation of a color:

Template usage example
----------------------

{% load colors %}

<b style="background:#00ffff;">Lorem</b>
<b style="background:#{{ "00ffff"|lightness:"40" }};">Ipsum</b>
<b style="background:{{ "0ff"|opposite|hex_to_rgb:"rgb(%d,%d,%d)" }};">
Dolor</b>

{# Rendered #}

<b style="background:#00ffff;">Lorem</b>
<b style="background:#006666;">Ipsum</b>
<b style="background:rgb(255, 0, 0);">Dolor</b>

ColorField usage example
----------------------

from colors.fields import ColorField

class Profile(models.Model):
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)
    bg_color = ColorField()

Outside django admin, ensure include JQuery and colors app css and js.

/static/colors/js/colorpicker.js
/static/colors/css/colorpicker.css

Installation
============

There is two ways to install this library. You can install it system wide or use it within your project.

System wide installation
------------------------

sudo python setup.py install

Local installation
------------------

Simply add the "colors" folder in your PYTHONPATH or copy it in your project folder.

Django setup
============

   1 Add 'colors' to your INSTALLED_APPS in settings.py
   2. In your template load it using {% load colors %}
   3. That's it !