update: 3.0.0

Author: T-Dynamos

.github/workflows/cibuildwheel.yml

@@ -0,0 +1,74 @@
+name: Build and Test Wheels
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - update
+    tags:
+      - 'v*'
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
+    - name: Install Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x' # cibuildwheel will use its own Python versions
+
+    - name: Install cibuildwheel
+      run: python -m pip install cibuildwheel
+    
+    - name: Build wheels
+      run: python -m cibuildwheel --output-dir wheelhouse
+      env:
+        CIBW_BUILD_VERBOSITY: 1
+        CIBW_SKIP: "cp37-* cp38-* pp*" # Skip Python 3.7, 3.8 and PyPy as per existing workflows
+        CIBW_ARCHS_MACOS: "x86_64 arm64" # Build for both architectures on macOS
+        CIBW_BEFORE_TEST: >
+          pip install -r {project}/requirements.txt -r {project}/requirements-dev.txt
+        CIBW_TEST_COMMAND: >
+          curl -L -o /tmp/test_image.jpg "https://unsplash.com/photos/zQLd8RXbenw/download?ixid=M3wxMjA3fDB8MXx0b3BpY3x8NnNNVmpUTFNrZVF8fHx8fDJ8fDE3MzY0MDA3NTd8&force=true&w=2400" &&
+          python {project}/tests/test_all.py --image /tmp/test_image.jpg --quality 1 --method pillow --tonal-spot &&
+          python {project}/tests/test_all.py --image /tmp/test_image.jpg --quality 1 --method cpp --tonal-spot
+        CIBW_BEFORE_BUILD: >
+          pip install setuptools wheel
+        CIBW_ENVIRONMENT: >
+          PURE_PYTHON=False
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: cibuildwheel-wheels-${{ matrix.os }}
+        path: wheelhouse/*.whl
+
+  deploy:
+    name: Publish to PyPI
+    needs: build_wheels
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Download all wheels
+      uses: actions/download-artifact@v4
+      with:
+        path: dist
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
+        packages_dir: dist

.github/workflows/default.yml

@@ -1 +1 @@
-__version__ = "2.0.10"
+__version__ = "3.0.0"

.github/workflows/linux.yml

@@ -1,16 +1,25 @@
-from materialyoucolor.hct import Hct
 from materialyoucolor.hct.cam16 import Cam16
+from materialyoucolor.hct.hct import Hct
+from materialyoucolor.utils.color_utils import lstar_from_argb
 from materialyoucolor.utils.math_utils import (
-    sanitize_degrees_double,
     difference_degrees,
     rotation_direction,
+    sanitize_degrees_double,
 )
-from materialyoucolor.utils.color_utils import lstar_from_argb
 
 
 class Blend:
+    """
+    Functions for blending in HCT and CAM16.
+    """
+
     @staticmethod
     def harmonize(design_color: int, source_color: int) -> int:
+        """
+        Blend the design color's HCT hue towards the key color's HCT
+        hue, in a way that leaves the original color recognizable and
+        recognizably shifted towards the key color.
+        """
         from_hct = Hct.from_int(design_color)
         to_hct = Hct.from_int(source_color)
         difference_degrees_ = difference_degrees(from_hct.hue, to_hct.hue)
@@ -22,17 +31,24 @@ def harmonize(design_color: int, source_color: int) -> int:
         return Hct.from_hct(output_hue, from_hct.chroma, from_hct.tone).to_int()
 
     @staticmethod
-    def hct_hue(from_: int, to: int, amount: int) -> int:
-        ucs = Blend.cam16_ucs(from_, to, amount)
+    def hct_hue(from_argb: int, to_argb: int, amount: float) -> int:
+        """
+        Blends hue from one color into another. The chroma and tone of
+        the original color are maintained.
+        """
+        ucs = Blend.cam16_ucs(from_argb, to_argb, amount)
         ucs_cam = Cam16.from_int(ucs)
-        from_cam = Cam16.from_int(from_)
-        blended = Hct.from_hct(ucs_cam.hue, from_cam.chroma, lstar_from_argb(from_))
+        from_cam = Cam16.from_int(from_argb)
+        blended = Hct.from_hct(ucs_cam.hue, from_cam.chroma, lstar_from_argb(from_argb))
         return blended.to_int()
 
     @staticmethod
-    def cam16_ucs(from_: int, to: int, amount: float) -> int:
-        from_cam = Cam16.from_int(from_)
-        to_cam = Cam16.from_int(to)
+    def cam16_ucs(from_argb: int, to_argb: int, amount: float) -> int:
+        """
+        Blend in CAM16-UCS space.
+        """
+        from_cam = Cam16.from_int(from_argb)
+        to_cam = Cam16.from_int(to_argb)
         from_j = from_cam.jstar
         from_a = from_cam.astar
         from_b = from_cam.bstar

.setup.py.kate-swp

@@ -1,5 +1,5 @@
+from materialyoucolor.utils.color_utils import lstar_from_y, y_from_lstar
 from materialyoucolor.utils.math_utils import clamp_double
-from materialyoucolor.utils.color_utils import y_from_lstar, lstar_from_y
 
 
 class Contrast:
@@ -11,7 +11,7 @@ def ratio_of_tones(tone_a: float, tone_b: float) -> float:
 
     @staticmethod
     def ratio_of_ys(y1: float, y2: float) -> float:
-        lighter = y1 if y1 > y2 else y2
+        lighter = max(y1, y2)
         darker = y1 if lighter == y2 else y2
         return (lighter + 5.0) / (darker + 5.0)
 
@@ -25,11 +25,12 @@ def lighter(tone: float, ratio: float) -> float:
         real_contrast = Contrast.ratio_of_ys(light_y, dark_y)
         delta = abs(real_contrast - ratio)
         if real_contrast < ratio and delta > 0.04:
-            return -1
+            return -1.0
 
         return_value = lstar_from_y(light_y) + 0.4
         if return_value < 0 or return_value > 100:
             return -1.0
+
         return return_value
 
     @staticmethod
@@ -38,24 +39,25 @@ def darker(tone: float, ratio: float) -> float:
             return -1.0
 
         light_y = y_from_lstar(tone)
-        dark_y = (light_y + 5.0) / ratio - 5.0
+        dark_y = ((light_y + 5.0) / ratio) - 5.0
         real_contrast = Contrast.ratio_of_ys(light_y, dark_y)
 
         delta = abs(real_contrast - ratio)
         if real_contrast < ratio and delta > 0.04:
-            return -1
+            return -1.0
 
         return_value = lstar_from_y(dark_y) - 0.4
-        if return_value < 0 or return_value > 100:
-            return -1
+        if return_value < 0.0 or return_value > 100.0:
+            return -1.0
+
         return return_value
 
     @staticmethod
-    def lighter_unsafe(tone, ratio):
+    def lighter_unsafe(tone: float, ratio: float) -> float:
         lighter_safe = Contrast.lighter(tone, ratio)
         return 100.0 if lighter_safe < 0.0 else lighter_safe
 
     @staticmethod
-    def darker_unsafe(tone, ratio):
+    def darker_unsafe(tone: float, ratio: float) -> float:
         darker_safe = Contrast.darker(tone, ratio)
         return 0.0 if darker_safe < 0.0 else darker_safe

materialyoucolor/__init__.py

@@ -0,0 +1 @@
+from .dislike import DislikeAnalyzer

materialyoucolor/blend/blend.py

@@ -1,4 +1,4 @@
-from materialyoucolor.hct import Hct
+from materialyoucolor.hct.hct import Hct
 
 
 class DislikeAnalyzer: