Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/t-dynamos/materialyoucolor-python
Material You color generation algorithms in python.
https://github.com/t-dynamos/materialyoucolor-python
color color-palette color-scheme dynamic-color dynamic-theme dynamic-wallpaper kivy kivymd material-you palette python
Last synced: about 1 month ago
JSON representation
Material You color generation algorithms in python.
- Host: GitHub
- URL: https://github.com/t-dynamos/materialyoucolor-python
- Owner: T-Dynamos
- License: mit
- Created: 2023-04-16T13:28:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-18T03:20:51.000Z (5 months ago)
- Last Synced: 2024-12-09T13:49:44.721Z (about 2 months ago)
- Topics: color, color-palette, color-scheme, dynamic-color, dynamic-theme, dynamic-wallpaper, kivy, kivymd, material-you, palette, python
- Language: Python
- Homepage:
- Size: 227 KB
- Stars: 40
- Watchers: 4
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Material You color algorithms](https://m3.material.io/styles/color/overview) for python!
It is built in reference with offical [typescript implementation](https://github.com/material-foundation/material-color-utilities/tree/main/typescript) except it's color quantization part, which is based on [c++ implementation](https://github.com/material-foundation/material-color-utilities/tree/main/cpp) thanks to [pybind](https://github.com/pybind).
## Features
1. Up to date with `material-foundation/material-color-utilities`.
2. Uses official c++ sources for quantization backend, which makes color generation fast!
## Minimal running example:
Run file `tests/test_all.py` as:
```console
python3 test_all.py
```
Maximum quality is `1` that means use all pixels, and quality number more than `1` means how many pixels to skip in between while reading, also you can see it as compression.
Click to view result
[Image Used, size was 8MB](https://unsplash.com/photos/zFMbpChjZGg/)
## Usage
### Install
You can easily install it from pip by executing:
```console
pip3 install materialyoucolor --upgrade
```
Prebuilt binaries are avaliable for `linux`, `windows` and `macos`. If prebuilt binaries aren't available, then you should manually build and install.
### Build and install
```console
# Install
pip3 install https://github.com/T-Dynamos/materialyoucolor-python/archive/master.zip
```
### OS Specific
#### Arch Linux
```console
yay -S python-materialyoucolor
```
Thanks :heart: to [@midn8hustlr](https://github.com/midn8hustlr) for this [AUR package](https://aur.archlinux.org/cgit/aur.git/?h=python-materialyoucolor-git).
#### Android (using kivy's [`buildozer`](https://github.com/kivy/buildozer))
Ensure these lines in `buildozer.spec`:
```python
requirements = materialyoucolor
p4a.branch = develop
```
#### IOS (using kivy's [`kivy-ios`](https://github.com/kivy/kivy-ios))
Install latest version of kivy-ios and use as:
```console
toolchain build materialyoucolor
```
## Usage examples
Click to show
- Generate non dynamic colors
```python
from materialyoucolor.scheme import Scheme
from materialyoucolor.scheme.scheme_android import SchemeAndroid
# Color is a an int, which is made as:
# 0xff + hex_code (without #)
# Eg: 0xff + #4181EE = 0xff4181EE
# To convert hex to this form, do `int("0xff" + "", 16)`
color = 0xff4181EE
print(Scheme.light(color).props)
print(Scheme.dark(color).props)
# Props is a dict, key is color name and value is rgba format list
# {'primary': [0, 90, 195, 255], 'onPrimary': ....
# Same way for android
print(SchemeAndroid.light(color).props)
print(SchemeAndroid.dark(color).props)
```
- Generate dynamic colors
```python
# Color in hue, chroma, tone form
from materialyoucolor.hct import Hct
from materialyoucolor.dynamiccolor.material_dynamic_colors import MaterialDynamicColors
# There are 9 different variants of scheme.
from materialyoucolor.scheme.scheme_tonal_spot import SchemeTonalSpot
# Others you can import: SchemeExpressive, SchemeFruitSalad, SchemeMonochrome, SchemeRainbow, SchemeVibrant, SchemeNeutral, SchemeFidelity and SchemeContent
# SchemeTonalSpot is android default
scheme = SchemeTonalSpot( # choose any scheme here
Hct.from_int(0xff4181EE), # source color in hct form
True, # dark mode
0.0, # contrast
)
for color in vars(MaterialDynamicColors).keys():
color_name = getattr(MaterialDynamicColors, color)
if hasattr(color_name, "get_hct"): # is a color
print(color, color_name.get_hct(scheme).to_rgba()) # print name of color and value in rgba format
# background [14, 20, 21, 255]
# onBackground [222, 227, 229, 255]
# surface [14, 20, 21, 255]
# surfaceDim [14, 20, 21, 255]
# ...
```
- Generate and score colors from image
```python
# Pillow is required to open image to array of pixels
from PIL import Image
# C++ QuantizeCelebi
from materialyoucolor.quantize import QuantizeCelebi, StbLoadImage
# Material You's default scoring of colors
from materialyoucolor.score.score import Score
# Open image
image = Image.open("path_to_some_image.jpg")
pixel_len = image.width * image.height
image_data = image.getdata()
# Alternate method
# image_data = StbLoadImage("path_to_some_image.jpg")
# Warning: This method is slower and much more resource intensive
# (eats too much ram) so use it with caution
# Quality 1 means skip no pixels
quality = 1
pixel_array = [image_data[_] for _ in range(0, pixel_len, quality)]
# Run algorithm
result = QuantizeCelebi(pixel_array, 128) # 128 -> number desired colors, default 128
print(result)
# {4278722365: 2320, 4278723396: 2405, 4278723657: 2366,...
# result is a dict where key is
# color in integer form (which you can convert later), and value is population
print(Score.score(result))
# [4278722365, 4278723657]
# list of selected colors in integer form
```
## FAQ
1. How it is different from `avanisubbiah/material-color-utilities`?
See https://github.com/T-Dynamos/materialyoucolor-python/issues/3