ColorController is a Pythonic interface for managing colors by english-language name and various color values.

Overview

ColorController.py

Table of Contents

  1. Encode color data in various formats.
  2. Modify a color using simple, convenient methods.
  3. Invert a color
  4. Access a rich set of color values and color names

Welcome to the ColorController Python library!

My name is Tal Zaken, and I wrote this library for use in a natural language processing project that aims to take in free-form text, and spit out color data which somehow relates to the text's content.

Enough about that. Here are some things that you can do with ColorController:

1. Encode color data in various formats.

Example 1.1: Create a ColorController object using a familiar, english-language color name, and print out its properties.

You can set a color using a very large library of color names. See the colornames.txt document contained herein, with enormous thanks to Martin Krzywinski.

The following code:

from ColorController import ColorController

color = ColorController(name='hazel')

print(f"Name: {color.name}",
      f"Hex Code: {color.hex_code}",
      f"RGB: {color.rgb}",
      f"HSV: {color.hsv}",
      sep='\n')

outputs:

Name: hazel
Hex Code: ['#8E7618']
RGB: [(142, 118, 24)]
HSV: [(0.133, 0.831, 142)]

Further, you can change all the ColorController's properties by changing any one of them.

By example:

color.name = 'blue'

print(f"Name: {color.name}", 
      f"Hex Code: {color.hex_code}", 
      f"RGB: {color.rgb}", 
      f"HSV: {color.hsv}", 
      sep='\n')

You will see that all properties have updated:

Name: blue
Hex Code: ['#00008B', '#0000CD', '#0000EE', '#0000FF', '#0018A8', '#0087BD', '#0093AF', '#0247FE', '#0343DF', '#1F75FE', '#2242C7', '#333399']
RGB: [(0, 0, 139), (0, 0, 205), (0, 0, 238), (0, 0, 255), (0, 24, 168), (0, 135, 189), (0, 147, 175), (2, 71, 254), (3, 67, 223), (31, 117, 254), (34, 66, 199), (51, 51, 153)]
HSV: [(0.667, 1.0, 139), (0.667, 1.0, 205), (0.667, 1.0, 238), (0.667, 1.0, 255), (0.643, 1.0, 168), (0.548, 1.0, 189), (0.527, 1.0, 175), (0.621, 0.992, 254), (0.618, 0.987, 223), (0.602, 0.878, 254), (0.634, 0.829, 199), (0.667, 0.667, 153)]

Notably, the colornames.txt file has numerous entries that all share the name "blue." This is true of many colors. Because color is thought to be a culturally relative phenomenon, I have chosen to return all hex codes that match a given name. You will notice a similar phenomenon occurs for color names when you set a color using hex code, RGB, or HSV. This is because there are sometimes many names that all describe the same color.

Example 1.2: Show a color.

We've had a lot of talk about colors so far, but we haven't even seen any colors yet! Let's solve that now, and do away with these lengthy print statements:

color.hex_code ='#ffbff9'

color.show_color()

Shows:

pale_orchid

That said, the ColorController object is biased toward whatever you, the user, set it to be. If you explicitly set a name, then that will be the singular name of your object. Similarly, if you explicitly set a hex code, then that will be the value of your hex code. If you leave a leading # off of your hex code, then everything will still work, but that will be the hex code value. For example...

Example 1.3: Create a ColorController object using a hex code.

color = ColorController(hex_code='#990000')

color.show_color()

Shows:

['crimson_red', 'stizza', 'ou_crimson_red', 'usc_cardinal']

While:

color.hex_code = '990000'

color.show_color()

Shows very similar results:

['crimson_red', 'stizza', 'ou_crimson_red', 'usc_cardinal']

Example 1.4: Create a ColorController object using an RGB triplet.

You can also pass a 3-tuple whose values are each contained in range(0,256) to the rgb property. For example:

color = ColorController(rgb=(10, 255, 230))

color.show_color()

Shows:

[bright_aqua]

Example 1.5: Create a ColorController object using an HSV triplet, and print out its properties.

Lastly, you can also pass a 3-tuple whose first two values are a floating point number between 0 and 1 inclusive, and whose third value falls in range(0, 256):

color = ColorController(hsv=(0.25, 1, 255))

color.show_color()

Shows:

[chartreuse]

NOTE: While this is the HSV value format that comes included with the colorsys python standard library, it doesn't seem to be a very common format elsewhere. To match formats used in other locations, see the following functions:

def colorsys_hsv_to_hsv360(colorsys_hsv=tuple):
    """Takes an HSV triplet as provided by colorsys, and converts it to match the
    notation used in colornames.txt"""

def hsv360_to_hsvdistance(hsv360=tuple):
    """Takes an HSV triplet as provided by colorsys_hsv_to_hsv360(), and converts it to match the
    notation used in the function for calculating distance between colors."""  

2. Modify a color using simple, convenient methods.

Example 2.1: Darken a color.

You can darken a color using the darken_color() method. For example:

from ColorController import ColorController

color = ColorController(name='forest')

color.show_color()

color.darken_color()

color.show_color()

Will show the following in series:

[forest] [hunter_green]

You can also pass in a darkening_value between zero and one, to set the percent darker you'd like to go. For instance:

color = ColorController(name='cocoa')

color.show_color()

color.darken_color(.3)

color.show_color()

Shows the following in series:

[cocoa] [nutmeg]

In the above example, note that our color object was first initiated by the name property, meaning that there are lists of associated hex, rgb, and hsv values stored in their respective properties. When we lighten the color, we have to select one index from these lists to operate on. The default behavior is to operate on the first index. See the unlist() function in helpers.py.

Example 2.2: Lighten a color.

You can also pass in a lightening_value between zero and one, to set the percent lighter you'd like to go. For instance:

color = ColorController(hex_code='#6c3461')

color.show_color()

color.lighten_color(.5)

color.show_color()

Shows the following in series:

[grape] [grayish_fuchsia]

Example 2.3: Brighten a color.

3. Invert a color.

Example:

from ColorController.conversions import invert_rgb
from ColorController import ColorController


color = ColorController(hex_code='#9ffeb0')
color.show_color()

r, g, b = color.rgb
color.rgb = invert_rgb(r, g, b)
color.show_color()

Shows the following in series:

[mint] [deep_orchid]

4. Access a rich set of color values and color names (prepared by Martin Krzywinski), conveniently stored in a Pandas DataFrame.

Example:

from ColorController.ColorController import colors_df

print(colors_df.iloc[5000])

Outputs:

IDX                                                                  5000
NAME                                                    light_apple_green
rgb                                                                   rgb
R                                                                     220
G                                                                     231
B                                                                     139
hex                                                                   hex
HEX                                                               #DCE78B
hsv                                                                   hsv
h                                                                      67
s                                                                      40
v                                                                      91
xyz                                                                   xyz
X                                                                    0.63
Y                                                                    0.74
Z                                                                    0.35
lab                                                                   lab
L                                                                      89
A                                                                     -17
B                                                                      44
lch                                                                   lch
L                                                                      89
C                                                                      47
H                                                                     112
cmyk                                                                 cmyk
C                                                                       4
M                                                                       0
Y                                                                      36
K                                                                       9
NEIGHBOUR_STR           PMS586[775][226,229,132](3.6):hypnotic[4592][2...
NUM_NEIGHBOURS_MAXDE                                                    4
WORD_TAGS               [light, PMS586, hypnotic, jonquil, green, lime...
Name: 5000, dtype: object

Known Bugs:

  • I don't know of any right now, but I'm sure they exist!

Ideas

  • tint and shade methods instead of or in addition to lighten/darken?
  • more unit tests
  • module to mix colors
    • this will require converting to LAB or another subtractive space, so more getter/setter methods

Resources:

Owner
Tal Zaken
Tal Zaken
Finger is a function symbol recognition engine for binary programs

Finger is a function symbol recognition engine for binary programs

332 Jan 01, 2023
A python script to generate wallpaper

wallpaper eits Warning You need to set the path to Robot Mono font in the source code. (Settings are in the main function) Usage A script that given a

Henrique Tsuyoshi Yara 5 Dec 02, 2021
tade is a discussion/forum/link aggregator application. It provides three interfaces: a regular web page, a mailing list bridge and an NNTP server

tade is a discussion/forum/link aggregator application. It provides three interfaces: a regular web page, a mailing list bridge and an NNTP server

Manos Pitsidianakis 23 Nov 04, 2022
Go through a random file in your favourite open source projects!

Random Source Codes Never be bored again! Staring at your screen and just scrolling the great world wide web? Would you rather read through some code

Mridul Seth 1 Nov 03, 2022
EthTx - Ethereum transactions decoder

EthTx - Ethereum transactions decoder Installation pip install ethtx Requirements The package needs a few external resources, defined in EthTxConfig o

398 Dec 25, 2022
A simulator for xkcd 2529's weirdly concrete problem

What is this? This is a quick hack implementation of a simulator for xkcd 2529's weirdly concrete problem. This is barely tested and I suck at computa

Reuben Steenekamp 6 Oct 27, 2021
Python code to divide big numbers

divide-big-num Python code to divide big numbers

VuMinhNgoc 1 Oct 15, 2021
Script to decrypt / import chromium (edge/chrome) cookies

Cloonie Script to decrypt / import chromium (edge/chrome) cookies. Requirements Install the python dependencies via pip: pip install -r requirements.t

Lorenzo Bernardi 5 Sep 13, 2022
Check the basic quality of any dataset

Data Quality Checker in Python Check the basic quality of any dataset. Sneak Peek Read full tutorial at Medium. Explore the app Requirements python 3.

MalaDeep 8 Feb 23, 2022
ColorController is a Pythonic interface for managing colors by english-language name and various color values.

ColorController.py Table of Contents Encode color data in various formats. 1.1: Create a ColorController object using a familiar, english-language col

Tal Zaken 2 Feb 12, 2022
Multipurpose Growtopia Server tools, can be used for newbie to learn things.

Information Multipurpose Growtopia Server tools, can be used for newbie to learn things. Requirements - Python 3.x - Operating System (Recommended : W

Morphias 2 Oct 29, 2021
A dictionary that can be flattened and re-inflated

deflatable-dict A dictionary that can be flattened and re-inflated. Particularly useful if you're interacting with yaml, for example. Installation wit

Lucas Sargent 2 Oct 18, 2021
A small python tool to get relevant values from SRI invoices

SriInvoiceProcessing A small python tool to get relevant values from SRI invoices Some useful info to run the tool Login into your SRI account and ret

Wladymir Brborich 2 Jan 07, 2022
Set of utilities for exporting/controlling your robot in Blender

Blender Robotics Utils This repository contains utilities for exporting/controlling your robot in Blender Maintainers This repository is maintained by

Robotology 33 Nov 30, 2022
Toolkit for collecting and applying templates of prompting instances

PromptSource Toolkit for collecting and applying templates of prompting instances. WIP Setup Download the repo Navigate to root directory of the repo

BigScience Workshop 1k Jan 05, 2023
A fixture that allows runtime xfail

pytest-runtime-xfail pytest plugin, providing a runtime_xfail fixture, which is callable as runtime_xfail(), to allow runtime decisions to mark a test

Brian Okken 4 Apr 06, 2022
Collection of code auto-generation utility scripts for the Horizon `Boot` system module

boot-scripts This is a collection of code auto-generation utility scripts for the Horizon Boot system module, intended for use in Atmosphère. Usage Us

4 Oct 11, 2022
🔩 Like builtins, but boltons. 250+ constructs, recipes, and snippets which extend (and rely on nothing but) the Python standard library. Nothing like Michael Bolton.

Boltons boltons should be builtins. Boltons is a set of over 230 BSD-licensed, pure-Python utilities in the same spirit as — and yet conspicuously mis

Mahmoud Hashemi 6k Jan 04, 2023
A Randomizer Oracle

Tezos Randomizer Tezod Randomizer "Oracle". It's a smart contract that you can call to get a random number between X and Y (for now). It uses entropy

Asbjorn Enge 19 Sep 13, 2022
PyHook is an offensive API hooking tool written in python designed to catch various credentials within the API call.

PyHook is the python implementation of my SharpHook project, It uses various API hooks in order to give us the desired credentials. PyHook Uses

Ilan Kalendarov 158 Dec 22, 2022