Generate color based on any object
Generate a color based on a value
This module generates a color based on an object, by calculating a color value based on a hash value for the object. This means the result is deterministic: the same value will always result in the same color (so long as the hash function remains deterministic).
This module is a port of the color-hash Javascript library.
It supports Python 3.7+ and it has no dependencies.
>>> from colorhash import ColorHash
>>> c = ColorHash('Hello World')
>>> c.hsl
(131, 0.65, 0.5)
>>> c.rgb
(45, 210, 75)
>>> c.hex
'#2dd24b'
Its hosted on PyPI.
pip install colorhash
You can influence every aspect of final color. Default values are following:
ColorHash(
obj: Any,
lightness: Sequence[float, ...] = (0.35, 0.5, 0.65), # picks 'randomly' one
saturation: Sequence[float, ...] = (0.35, 0.5, 0.65), # picks 'randomly' one
min_h: Optional[int] = None, # hue, min 0
max_h: Optional[int] = None, # hue, max 360
)
But be careful, setting tight conditions may result in very similar colors. See example tables.
You can fix lightness or saturation to single value(s) by using sequence with 1 element (eg. [0.5]
).
code | hex | color |
---|---|---|
ColorHash('hey') # default |
#782d86 |
|
ColorHash('hey', lightness=[0.55]) |
#b453c6 |
|
ColorHash('hey', lightness=[0.75]) |
#d69fdf |
|
ColorHash('hey', lightness=[0.95]) |
#f7ecf9 |
|
ColorHash('hey', saturation=[0.15]) |
#8d6c93 |
|
ColorHash('hey', saturation=[0.55]) |
#b139c6 |
|
ColorHash('hey', saturation=[0.95]) |
#d406f9 |
|
ColorHash('hey', lightness=[0.95], saturation=[0.95]) |
#fbe6fe |
|
ColorHash('oh', lightness=[0.95], saturation=[0.95]) |
#fef0e6 |
|
ColorHash('boi', lightness=[0.95], saturation=[0.95]) |
#e6fee7 |
You can set hue range or even fix it by setting min_h
= max_h
.
code | hex | color |
---|---|---|
ColorHash('hey', min_h=150) |
#2d5886 |
|
ColorHash('hey', min_h=300) |
#862d6c |
|
ColorHash('hey', max_h=150) |
#866e2d |
|
ColorHash('hey', min_h=150, max_h=360) |
#2d5886 |
|
ColorHash('hey', min_h=150, max_h=150) # fixed hue |
#2d8659 |
Or you can let ColorHash
decide between combination of many lightness
and saturation
options (mind min_h
and max_h
are equal in this example).
code | hex | color |
---|---|---|
ColorHash('stick', min_h=65, max_h=65, saturation=[x/10 for x in range(1, 10)], lightness=[x/10 for x in range(1, 10)]) |
#869108 |
|
ColorHash('with', min_h=65, max_h=65, saturation=[x/10 for x in range(1, 10)], lightness=[x/10 for x in range(1, 10)]) |
#eef5a3 |
|
ColorHash('one', min_h=65, max_h=65, saturation=[x/10 for x in range(1, 10)], lightness=[x/10 for x in range(1, 10)]) |
#ddeb47 |
Finally some bad examples. When you set too strict rules, colors may be almost identical.
code | hex | color |
---|---|---|
ColorHash('lets', lightness=[0.95], saturation=[0.95], min_h=300) |
#fee6f8 |
|
ColorHash('break', lightness=[0.95], saturation=[0.95], min_h=300) |
#fee6fb |
|
ColorHash('it', lightness=[0.95], saturation=[0.95], min_h=300) |
#fee6fa |
|
ColorHash('here', min_h=150, max_h=150) |
#6ce0a6 |
|
ColorHash('goes', min_h=150, max_h=150) |
#79d2a6 |
|
ColorHash('almost', min_h=150, max_h=150) |
#6ce0a6 |
|
ColorHash('same', min_h=150, max_h=150) |
#79d2a6 |
|
ColorHash('color', min_h=150, max_h=150) |
#6ce0a6 |
hsl2rgb()
importlib-metadata
importpy.typed
to support type annotations (#4)poetry
tox
pip-tools
(manage dependencies)hatch
(build & test)twine
(publish)python3.11
python3.6
(downloads from PyPI are under 1%)python3.6
python3.6+
python2.x
crc32_hash
function and set default hashfunc to that. It's not
fully backwards-compatible, but I don't want to bump the version a lot for
not doing my research.Running pytest
(1600+ tests) on different python versions.
python | secs |
---|---|
3.7 | 1.252 |
3.8 | 1.239 |
3.9 | 0.720 |
3.10 | 0.690 |
3.11 | 0.892 |
Copyright (c) 2016 Felix Krull f_krull@gmx.de
This is a port of the 'color-hash' Javascript library which is:
Copyright (c) 2015 Zeno Zeng
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.