update README

Author: T-Dynamos

README.md

@@ -13,19 +13,43 @@ It is built in reference with offical [typescript implementation](https://github
 Run file `tests/test_all.py` as:
 
 ```console
-python3 test_all.py <image path> <quality>
-
+usage: test_all.py [-h] [--tonal-spot] [--expressive] [--fidelity] [--fruit-salad] [--monochrome] [--neutral] [--rainbow] [--vibrant]
+                   [--content] [--all] [--image IMAGE] [--quality QUALITY] [--method {pillow,cpp}]
+
+Material You Color Scheme Test
+
+options:
+  -h, --help            show this help message and exit
+  --tonal-spot          Print the tonal-spot dynamic scheme
+  --expressive          Print the expressive dynamic scheme
+  --fidelity            Print the fidelity dynamic scheme
+  --fruit-salad         Print the fruit-salad dynamic scheme
+  --monochrome          Print the monochrome dynamic scheme
+  --neutral             Print the neutral dynamic scheme
+  --rainbow             Print the rainbow dynamic scheme
+  --vibrant             Print the vibrant dynamic scheme
+  --content             Print the content dynamic scheme
+  --all                 Print all dynamic schemes (default)
+  --image IMAGE         Path to an image file for color extraction
+  --quality QUALITY     Quality for image quantization (default: 5)
+  --method {pillow,cpp}
+                        Method for color quantization (default: cpp)
 ```
-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.
 
 <details>
     <summary>Click to view result</summary>
 
 [Image Used, size was 8MB](https://unsplash.com/photos/zFMbpChjZGg/)
 
-![image](https://github.com/T-Dynamos/materialyoucolor-pyhton/assets/68729523/9d5374c9-00b4-4b70-b82a-6792dd5c910f)
-![image](https://github.com/T-Dynamos/materialyoucolor-pyhton/assets/68729523/2edd819f-8600-4c82-a18a-3b759f63a552)
+<img width="666" height="516" alt="image" src="https://github.com/user-attachments/assets/68bc415b-3eb5-41d4-96e3-f36ced7411a8" />
+
+
+It is recommended to use the `cpp` backend, as the `pillow` backend is extremely memory-inefficient for large images.
+Newer Pillow APIs such as `Image.get_flattened_data()` eagerly materialize the entire image into a full list,
+so quality-based subsampling is applied only after full expansion and does not reduce memory usage.
+While `Image.getdata()` allows sampling during iteration, it is deprecated.
 
+The `cpp` backend avoids these issues by operating directly on compact pixel buffers.
 
 </details>
 
@@ -50,7 +74,7 @@ pip3 install https://github.com/T-Dynamos/materialyoucolor-python/archive/master
 ```
 ### OS Specific
 
-#### Arch Linux
+#### Arch Linux (OUTDATED)
 
 ```console
 yay -S python-materialyoucolor
@@ -62,7 +86,7 @@ Thanks :heart: to [@midn8hustlr](https://github.com/midn8hustlr) for this [AUR p
 
 Ensure these lines in `buildozer.spec`:
 ```python
-requirements = materialyoucolor
+requirements = materialyoucolor==3.0.0
 p4a.branch = develop
 ```
 
@@ -103,6 +127,7 @@ print(SchemeAndroid.dark(color).props)
 ```python
 # Color in hue, chroma, tone form
 from materialyoucolor.hct import Hct
+from materialyoucolor.dynamiccolor.color_spec import COLOR_NAMES
 from materialyoucolor.dynamiccolor.material_dynamic_colors import MaterialDynamicColors
 
 # There are 9 different variants of scheme.
@@ -114,60 +139,65 @@ scheme = SchemeTonalSpot( # choose any scheme here
     Hct.from_int(0xff4181EE), # source color in hct form
     True, # dark mode
     0.0, # contrast
+    spec_version="2025"
 )
 
-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]
-# ...
+mdc = MaterialDynamicColors(spec="2025")
+
+for color in COLOR_NAMES:
+    _color = getattr(mdc, color)
+    print(color, _color.get_rgba(scheme), _color.get_hex(scheme))
+
+# background [13, 14, 18, 255] #0D0E12FF
+# onBackground [227, 229, 240, 255] #E3E5F0FF
+# surface [13, 14, 18, 255] #0D0E12FF
+# surfaceDim [13, 14, 18, 255] #0D0E12FF
+# surfaceBright [41, 44, 52, 255] #292C34FF
+# surfaceContainerLowest [0, 0, 0, 255] #000000FF
+# surfaceContainerLow [17, 19, 24, 255] #111318FF
+# surfaceContainer [23, 25, 31, 255] #17191FFF
+# surfaceContainerHigh [29, 31, 38, 255] #1D1F26FF
+# surfaceContainerHighest [35, 38, 45, 255] #23262DFF
+# onSurface [227, 229, 240, 255] #E3E5F0FF
+# surfaceVariant [35, 38, 45, 255] #23262DFF
+# onSurfaceVariant [196, 198, 208, 255] #C4C6D0FF
+# outline [142, 144, 154, 255] #8E909AFF
+...
 ```
 
 - 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, ImageQuantizeCelebi
-# 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()
-
-# Quality 1 means skip no pixels
+# Pixel subsampling factor (quality = 1 processes all 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
 
-# Alternate C++ method
-# this is generally faster, but gives less control over image
-# result = ImageQuantizeCelebi("path_to_some_image.jpg", quality, 128)
+# Run Celebi color quantization on an image.
+# Returns a dict: {ARGB_color_int: population}
+result = ImageQuantizeCelebi(
+    "example.jpg",
+    quality,
+    128,  # maximum number of colors
+)
 
 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
+# Rank and select the best theme colors.
+# Returns a list of ARGB color integers.
+selected_colors = Score.score(result)
 
+print(selected_colors)
+# {4278911493: 276721,
+# 4280550664: 164247, 
+# 4280683034: 144830,
+# ...
 ```
 </details>
 
 ## FAQ
 
 1. How it is different from `avanisubbiah/material-color-utilities`?
 
-See https://github.com/T-Dynamos/materialyoucolor-python/issues/3
+This library is up to date, fast, and uses a hybrid system for image generation.

materialyoucolor/dislike/__init__.py

@@ -1 +1 @@
-from .dislike import DislikeAnalyzer
+from .dislike_analyzer import DislikeAnalyzer

materialyoucolor/scheme/__init__.py

@@ -7,3 +7,5 @@
 from .scheme_rainbow import SchemeRainbow
 from .scheme_tonal_spot import SchemeTonalSpot
 from .scheme_vibrant import SchemeVibrant
+from .scheme import Scheme
+from .scheme_android import SchemeAndroid

tests/test_all.py

@@ -1,25 +1,24 @@
 import argparse
 import os
+import time
 
 import psutil
 from PIL import Image
 from rich.console import Console
 from rich.table import Table
 
+from materialyoucolor.dynamiccolor.color_spec import COLOR_NAMES
 from materialyoucolor.dynamiccolor.material_dynamic_colors import MaterialDynamicColors
 from materialyoucolor.hct.hct import Hct
 
-
-# non-dynamic scheme
-from materialyoucolor.scheme.scheme import Scheme
-from materialyoucolor.scheme.scheme_android import SchemeAndroid
-
 # dynamic schemes
 # import all schemes
 from materialyoucolor.scheme import *
 
+# non-dynamic scheme
+from materialyoucolor.scheme.scheme import Scheme
+from materialyoucolor.scheme.scheme_android import SchemeAndroid
 from materialyoucolor.score.score import Score
-from materialyoucolor.dynamiccolor.color_spec import COLOR_NAMES
 from materialyoucolor.utils.color_utils import hex_from_rgba, rgba_from_argb
 
 
@@ -69,8 +68,8 @@ def get_current_rss_mb():
     "--method",
     type=str,
     choices=["pillow", "cpp"],
-    default="pillow",
-    help="Method for color quantization (default: pillow)",
+    default="cpp",
+    help="Method for color quantization (default: cpp)",
 )
 args = parser.parse_args()
 
@@ -81,7 +80,7 @@ def get_current_rss_mb():
 
         print("########## PILLOW METHOD ##########")
         initial_memory = get_current_rss_mb()
-        start = default_timer()
+        start = time.time()
         image = Image.open(args.image)
         pixel_len = image.width * image.height
         try:
@@ -91,7 +90,7 @@ def get_current_rss_mb():
         colors = QuantizeCelebi(
             [image_data[i] for i in range(0, pixel_len, args.quality)], MAX_COLOR
         )
-        end = default_timer()
+        end = time.time()
         final_memory = get_current_rss_mb()
         print(f"Color[pillow] generation took {end - start:.4f} secs")
         print(f"Peak RAM usage (Pillow): {final_memory - initial_memory:.2f} MB")
@@ -101,9 +100,9 @@ def get_current_rss_mb():
 
         print("########## C++ Method ##########")
         initial_memory = get_current_rss_mb()
-        start = default_timer()
+        start = time.time()
         colors = ImageQuantizeCelebi(args.image, args.quality, MAX_COLOR)
-        end = default_timer()
+        end = time.time()
         final_memory = get_current_rss_mb()
         print(f"Color[stb_image] generation took {end - start:.4f} secs")
         print(f"Peak RAM usage (C++): {final_memory - initial_memory:.2f} MB")