| Name | colorhash JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | |
| Summary | Generate color based on any object |
| upload_time | 2023-09-25 10:47:29 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | MIT |
| keywords |
color
hash
hex
hsl
rgb
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# color-hash
**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](https://github.com/zenozeng/color-hash).
It supports Python 3.7+ and it has no dependencies.
## Quick Start
```python
>>> from colorhash import ColorHash
>>> c = ColorHash('Hello World')
>>> c.hsl
(131, 0.65, 0.5)
>>> c.rgb
(45, 210, 75)
>>> c.hex
'#2dd24b'
```
## Installation
Its hosted on PyPI.
```bash
pip install colorhash
```
## Advanced usage
You can influence every aspect of final color. **Default values** are following:
```python
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` |  |
## Changelog
- color-hash **2.0.0** *(2023-09-22)*
- ✨ Expose params to influence colors
- ✨ Runtime validation of input params
- 📝 Update docs for advanced usage
- color-hash **1.3.2** *(2023-09-21)*
- ⚡️ 30%+ speedup on `hsl2rgb()`
- ✅ Add tests for all named colors (1500+ tests)
- color-hash **1.3.1** *(2023-09-21)*
- 🐛 Handle missing `importlib-metadata` import
- color-hash **1.3.0** *(2023-09-20)*
- 🧑💻 Add `py.typed` to support type annotations (#4)
- 📦 Changed packaging ecosystem
- ➖ Remove `poetry`
- ➖ Remove `tox`
- ➕ Add `pip-tools` (manage dependencies)
- ➕ Add `hatch` (build & test)
- ➕ Add `twine` (publish)
- ✨ Support `python3.11`
- ⚰️ Drop support for `python3.6` (downloads from PyPI are under 1%)
- color-hash **1.2.2** *(2022-10-17)*
- ✨ Add publish helper script
- color-hash **1.2.1** *(2022-10-17)*
- 📝 Update docs
- color-hash **1.2.0** *(2022-10-17)*
- 🧑💻 Use typing supporting `python3.6`
- color-hash **1.1.0** *(2022-09-01)*
- ✅ Add tests
- 🚸 Add installation instructions
- color-hash **1.0.4** *(2021-11-30)*
- Support only for `python3.6+`
- ✅ Add tests
- color-hash **1.0.3** *(2020-12-04)*
- ⚰️ Drop support for `python2.x`
- 🎉 Handover of project maintenance
- color-hash **1.0.2** *(2016-07-08)*
- ✨ Add ``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.
- color-hash **1.0.0** *(2016-07-07)*
- 🎉 Initial port.
## Speed comparison
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` |
## License
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "colorhash",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "color,hash,hex,hsl,rgb",
"author": "",
"author_email": "dimostenis <dimosh3k@gmail.com>, Felix Krull <f_krull@gmx.de>",
"download_url": "https://files.pythonhosted.org/packages/77/4b/514115dffc59a54eca31c748e473f6f780535e00db31e25cffc88abd2281/colorhash-2.0.0.tar.gz",
"platform": null,
"description": "# color-hash\n\n**Generate a color based on a value**\n\nThis module generates a color based on an object, by calculating a color value\nbased on a hash value for the object. This means the result is deterministic:\nthe same value will always result in the same color (so long as the hash\nfunction remains deterministic).\n\nThis module is a port of the [color-hash Javascript library](https://github.com/zenozeng/color-hash).\n\nIt supports Python 3.7+ and it has no dependencies.\n\n## Quick Start\n\n```python\n>>> from colorhash import ColorHash\n>>> c = ColorHash('Hello World')\n>>> c.hsl\n(131, 0.65, 0.5)\n>>> c.rgb\n(45, 210, 75)\n>>> c.hex\n'#2dd24b'\n```\n\n## Installation\n\nIts hosted on PyPI.\n\n```bash\npip install colorhash\n```\n\n## Advanced usage\n\nYou can influence every aspect of final color. **Default values** are following:\n\n```python\nColorHash(\n obj: Any,\n lightness: Sequence[float, ...] = (0.35, 0.5, 0.65), #\u00a0picks 'randomly' one\n saturation: Sequence[float, ...] = (0.35, 0.5, 0.65), #\u00a0picks 'randomly' one\n min_h: Optional[int] = None, #\u00a0hue, min 0\n max_h: Optional[int] = None, #\u00a0hue, max 360\n)\n```\n\nBut be careful, **setting tight conditions may result in very similar colors**. See example tables.\n\nYou can fix lightness or saturation to single value(s) by using sequence with 1 element (eg. `[0.5]`).\n\n| code | hex | color |\n|:--------------------------------------|:---------:|:-------------------------------:|\n| `ColorHash('hey') # default` | `#782d86` |  |\n| `ColorHash('hey', lightness=[0.55])` | `#b453c6` |  |\n| `ColorHash('hey', lightness=[0.75])` | `#d69fdf` |  |\n| `ColorHash('hey', lightness=[0.95])` | `#f7ecf9` |  |\n| `ColorHash('hey', saturation=[0.15])` | `#8d6c93` |  |\n| `ColorHash('hey', saturation=[0.55])` | `#b139c6` |  |\n| `ColorHash('hey', saturation=[0.95])` | `#d406f9` |  |\n| `ColorHash('hey', lightness=[0.95], saturation=[0.95])` | `#fbe6fe` |  |\n| `ColorHash('oh', lightness=[0.95], saturation=[0.95])` | `#fef0e6` |  |\n| `ColorHash('boi', lightness=[0.95], saturation=[0.95])` | `#e6fee7` |  |\n\nYou can set hue range or even fix it by setting `min_h` = `max_h`.\n\n| code | hex | color |\n|:--------------------------------------|:---------:|:-------------------------------:|\n| `ColorHash('hey', min_h=150)` | `#2d5886` |  |\n| `ColorHash('hey', min_h=300)` | `#862d6c` |  |\n| `ColorHash('hey', max_h=150)` | `#866e2d` |  |\n| `ColorHash('hey', min_h=150, max_h=360)` | `#2d5886` |  |\n| `ColorHash('hey', min_h=150, max_h=150) # fixed hue` | `#2d8659` |  |\n\nOr you can let `ColorHash` decide between combination of many `lightness` and `saturation` options (mind `min_h` and `max_h` are equal in this example).\n\n| code | hex | color |\n|:--------------------------------------|:---------:|:-------------------------------:|\n| `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` |  |\n| `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` |  |\n| `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` |  |\n\nFinally some bad examples. When you set too strict rules, colors may be almost identical.\n\n| code | hex | color |\n|:--------------------------------------|:---------:|:-------------------------------:|\n| `ColorHash('lets', lightness=[0.95], saturation=[0.95], min_h=300)` | `#fee6f8` |  |\n| `ColorHash('break', lightness=[0.95], saturation=[0.95], min_h=300)` | `#fee6fb` |  |\n| `ColorHash('it', lightness=[0.95], saturation=[0.95], min_h=300)` | `#fee6fa` |  |\n| `ColorHash('here', min_h=150, max_h=150)` | `#6ce0a6` |  |\n| `ColorHash('goes', min_h=150, max_h=150)` | `#79d2a6` |  |\n| `ColorHash('almost', min_h=150, max_h=150)` | `#6ce0a6` |  |\n| `ColorHash('same', min_h=150, max_h=150)` | `#79d2a6` |  |\n| `ColorHash('color', min_h=150, max_h=150)` | `#6ce0a6` |  |\n\n\n## Changelog\n\n- color-hash **2.0.0** *(2023-09-22)*\n - \u2728 Expose params to influence colors\n - \u2728 Runtime validation of input params\n - \ud83d\udcdd Update docs for advanced usage\n- color-hash **1.3.2** *(2023-09-21)*\n - \u26a1\ufe0f 30%+ speedup on `hsl2rgb()`\n - \u2705 Add tests for all named colors (1500+ tests)\n- color-hash **1.3.1** *(2023-09-21)*\n - \ud83d\udc1b Handle missing `importlib-metadata` import\n- color-hash **1.3.0** *(2023-09-20)*\n - \ud83e\uddd1\u200d\ud83d\udcbb Add `py.typed` to support type annotations (#4)\n - \ud83d\udce6 Changed packaging ecosystem\n - \u2796 Remove `poetry`\n - \u2796 Remove `tox`\n - \u2795 Add `pip-tools` (manage dependencies)\n - \u2795 Add `hatch` (build & test)\n - \u2795 Add `twine` (publish)\n - \u2728 Support `python3.11`\n - \u26b0\ufe0f Drop support for `python3.6` (downloads from PyPI are under 1%)\n- color-hash **1.2.2** *(2022-10-17)*\n - \u2728 Add publish helper script\n- color-hash **1.2.1** *(2022-10-17)*\n - \ud83d\udcdd Update docs\n- color-hash **1.2.0** *(2022-10-17)*\n - \ud83e\uddd1\u200d\ud83d\udcbb Use typing supporting `python3.6`\n- color-hash **1.1.0** *(2022-09-01)*\n - \u2705 Add tests\n - \ud83d\udeb8 Add installation instructions\n- color-hash **1.0.4** *(2021-11-30)*\n - Support only for `python3.6+`\n - \u2705 Add tests\n- color-hash **1.0.3** *(2020-12-04)*\n - \u26b0\ufe0f Drop support for `python2.x`\n - \ud83c\udf89 Handover of project maintenance\n- color-hash **1.0.2** *(2016-07-08)*\n - \u2728 Add ``crc32_hash`` function and set default hashfunc to that. It's not\n fully backwards-compatible, but I don't want to bump the version a lot for\n not doing my research.\n- color-hash **1.0.0** *(2016-07-07)*\n - \ud83c\udf89 Initial port.\n\n## Speed comparison\n\nRunning `pytest` (1600+ tests) on different python versions.\n\n| python | secs |\n| :----: | :-----: |\n| 3.7 | `1.252` |\n| 3.8 | `1.239` |\n| 3.9 | `0.720` |\n| 3.10 | `0.690` |\n| 3.11 | `0.892` |\n\n## License\n\nCopyright (c) 2016 Felix Krull <f_krull@gmx.de>\n\nThis is a port of the 'color-hash' Javascript library which is:\n\nCopyright (c) 2015 Zeno Zeng\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generate color based on any object",
"version": "2.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/dimostenis/color-hash-python/issues",
"Homepage": "https://github.com/dimostenis/color-hash-python"
},
"split_keywords": [
"color",
"hash",
"hex",
"hsl",
"rgb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a158f570e4e53ff5625415e22d8b51ee9019b1d364d111df4e24561f6ba21d01",
"md5": "a05eec6367d563fd3a9a98138618223a",
"sha256": "560fd010f545ae4d5323c3dd4f664cbc8c8d75555c5766c22b47be64acce722f"
},
"downloads": -1,
"filename": "colorhash-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a05eec6367d563fd3a9a98138618223a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6401,
"upload_time": "2023-09-25T10:47:28",
"upload_time_iso_8601": "2023-09-25T10:47:28.464739Z",
"url": "https://files.pythonhosted.org/packages/a1/58/f570e4e53ff5625415e22d8b51ee9019b1d364d111df4e24561f6ba21d01/colorhash-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "774b514115dffc59a54eca31c748e473f6f780535e00db31e25cffc88abd2281",
"md5": "1f8a99ad743ed4f8660b718e88919bfd",
"sha256": "f8171ea6bd3e1f3b9345bf837acc35576062c3b78e5048dc0e37651e09e4a118"
},
"downloads": -1,
"filename": "colorhash-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1f8a99ad743ed4f8660b718e88919bfd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7789,
"upload_time": "2023-09-25T10:47:29",
"upload_time_iso_8601": "2023-09-25T10:47:29.796527Z",
"url": "https://files.pythonhosted.org/packages/77/4b/514115dffc59a54eca31c748e473f6f780535e00db31e25cffc88abd2281/colorhash-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 10:47:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dimostenis",
"github_project": "color-hash-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "colorhash"
}
