untoreh / colors.py

Colors aren't that scary!

Changes from mattrobenolt/colors.py

These changes are still not in the main repo

• Test suite
• #9 Support for Python 3
• #9 Using decorators instead of metaclass (to keep it simple)
• #10 RGBColor is strictly 24bit (rounds the rgb input to)
• Added RGBFloatColor that represent colors in a 0.0 - 1.0 range

colors.py

Convert colors between rgb, hsv, and hex, perform arithmetic, blend modes, and generate random colors within boundaries

Installation

Either grab the version explicit or use master.
$ pip install https://github.com/Jerakin/colors.py/archive/master.zip

Latest release is "0.3.4 added alias for RGBFloat rgbf"

• pip install https://github.com/Jerakin/colors.py/releases/download/0.3.4/colors.py-0.3.4-py2.py3-none-any.whl

Basic Uses

Importing

The package exposes the aliases rgb, rgbf, hsv and importantly random and hex. Hex clashes with the builtin hex and random with the random module, it is therefore recommended to import colors as import colors. If you know you will not be using hex you can import the aliases for easy of use from colors import rgb, hsv, hex, random.

>>> import colors

Create an RGB color object

>>> colors.rgb(100, 100, 100)
<RGBColor red: 100, green: 100, blue: 100>

Convert it to hexadecimal

>>> colors.rgb(100, 100, 100).hex
<HexColor red: 64, green: 64, blue: 64>

Coerce the hexadecimal to a normal string

>>> str(colors.rgb(100, 100, 100).hex)
646464

Create a Hexadecimal color object

>>> colors.hex('646464')
<HexColor red: 64, green: 64, blue: 64>

Extract the red/green/blue value from a hexadecimal

>>> colors.hex('646464').rgb.red
100

Convert a hexadecimal to HSV

>>> colors.hex('646464').hsv
<HSVColor hue: 0.0, saturation: 0.0, value: 0.392156862745>

Coerce hsv/rgb values to a list/tuple of values

>>> list(colors.hex('646464').hsv)
[0.0, 0.0, 0.39215686274509803]

Create an HSV color object

>>> colors.hsv(0, 1, 1)
<HSVColor hue: 0, saturation: 1, value: 1>

Convert it to RGB

>>> colors.hsv(0, 1, 1).rgb
<RGBColor red: 255, green: 0, blue: 0>

Create an float RGB color object

>>> colors.rgbf(0.5, 0.5, 0.5)
<RGBFloatColor red: 0.5, green: 0.5, blue: 0.5>

Convert it to RGB

>>> colors.rgbf(0.5, 0.5, 0.5).rgb
<RGBColor red: 128, green: 128, blue: 128>

Gimme a random color, any color!

>>> colors.random()
<HSVColor hue: 0.812436498638, saturation: 0.621033239007, value: 0.379850638405>

Coerce a hexadecimal color to a string with formatting

>>> '#%s' % colors.random().hex
'#2f2336'

Coerce RGB/HSV objects to a string for formatting

>>> 'style="color: rgb(%s)"' % colors.random().rgb
'style="color: rgb(80, 124, 71)"'

Compare color equality

>>> colors.rgb(100, 100, 100) == colors.hex('646464')
True
>>> colors.hsv(0, 1, 1) == colors.rgb(255, 0, 0)
True

Arithmetic

Note: All arithmetic operations return rgb color.

Multiply

>>> colors.hex('ff9999') * colors.hex('cccccc')
<RGBColor red: 204, green: 122, blue: 122>
>>> colors.hex
<HexColor red: cc, green: 7a, blue: 7a>
>>> colors.rgb(100, 100, 100).multiply(colors.hsv(0, 1, 1)).hex
>>> <HexColor red: 64, green: 00, blue: 00>

Add

>>> colors.hex('ff9999') + colors.rgb(10, 10, 10)
<RGBColor red: 255, green: 163, blue: 163>
>>> colors.hex('aaffcc').add(colors.rgb(10, 10, 10))
<RGBColor red: 180, green: 255, blue: 214>

Subtract

>>> colors.hex('ff9999') - colors.rgb(10, 10, 10)
<RGBColor red: 245, green: 143, blue: 143>
>>> colors.hex('aaffcc').subtract(colors.rgb(10, 10, 10))
<RGBColor red: 160, green: 245, blue: 194>

Divide

>>> colors.hex('ff9999') / colors.rgb(10, 10, 10)
<RGBColor red: 26, green: 15, blue: 15>
>>> colors.hex('aaffcc').divide(colors.rgb(10, 10, 10))
<RGBColor red: 17, green: 26, blue: 20>
>>> colors.rgb(100, 100, 100) / hex('00ffff')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "colors.py", line 73, in divide
    raise ZeroDivisionError
ZeroDivisionError

Blend Modes

Note: All blend modes return rgb color.

Screen

>>> colors.hex('ff9999').screen(colors.rgb(10, 10, 10)).hex
<HexColor red: ff, green: 9d, blue: 9d>

Difference

>>> colors.hex('ff9999').difference(colors.rgb(10, 10, 10)).hex
<HexColor red: f5, green: 8f, blue: 8f>

Overlay

>>> colors.hex('ff9999').overlay(colors.rgb(10, 10, 10)).hex
<HexColor red: ff, green: 9b, blue: 9b>

Invert

>>> colors.hex('000000').invert()
<RGBColor red: 255, green: 255, blue: 255>

Color palettes

colors.py current ships with three color palettes full of constants. See source for all available colors.

colors.primary

>>> import colors.primary
>>> colors.primary.red
<RGBColor red: 255, green: 0, blue: 0>

colors.rainbow

>>> import colors.rainbow
>>> colors.rainbow.indigo
<RGBColor red: 75, green: 0, blue: 130>

colors.w3c

>>> import colors.w3c
>>> colors.w3c.ghostwhite
<RGBColor red: 248, green: 248, blue: 255>

The Color Wheel!

The color wheel allows you to randomly choose colors while keeping the colors relatively evenly distributed. Think generating random colors without pooling in one hue, e.g., not 50 green, and 1 red.

>>> from colors import ColorWheel
>>> wheel = ColorWheel()

Iterate the wheel to get the next value

ColorWheel is an iterable, but be careful if using inside any type of loop. It will iterate forever until you interject.

>>> wheel.next()
<HSVColor hue: 0.177410230076, saturation: 1, value: 0.8>
>>> wheel.next()
<HSVColor hue: 0.278803914372, saturation: 1, value: 0.8>
>>> for color in wheel:
...   print color.hex
00cca4
002ecc
# Forever and ever and ever and ever