Merge branch 'release/v0.2.2'

Author: KelSolaar

.coveragerc

@@ -3,6 +3,8 @@ source = colour_checker_detection
 sigterm = True
 [report]
 exclude_lines =
-    pragma: no cover
+    if TYPE_CHECKING:
     if __name__ == .__main__.:
+    if typing.TYPE_CHECKING:
     pass
+    pragma: no cover

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -7,7 +7,7 @@ body:
   - type: markdown
     attributes:
       value: >
-        Thank you for taking the time to file a feature request. Before continuing, please take some time to check the existing [issues](https://github.com/colour-science/colour-checker-detection/issues) and also the [draft release notes](https://gist.github.com/KelSolaar/4a6ebe9ec3d389f0934b154fec8df51d).
+        Thank you for taking the time to file a feature request. Before continuing, please take some time to check the existing [issues](https://github.com/colour-science/colour-checker-detection/issues).
 
   - type: textarea
     attributes:

.github/PULL_REQUEST_TEMPLATE.md

@@ -19,7 +19,7 @@ is available to guide the process: https://www.colour-science.org/contributing/.
 - [ ] Pre-commit hooks have been run and passed.
 
 <!-- The unit tests can be invoked with `uv run invoke tests` -->
-<!-- Pyright can be started with `pyright --threads --skipunannotated` -->
+<!-- Pyright can be started with `uv run pyright --threads --skipunannotated` -->
 
 **Documentation**
 

.github/workflows/continuous-integration-documentation.yml

@@ -25,6 +25,19 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+      - name: Clean Up Disk Space
+        run: |
+          df -h /
+
+          sudo rm -rf /usr/lib/jvm
+          sudo rm -rf /usr/local/.ghcup
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /usr/local/share/powershell
+          sudo rm -rf /usr/share/dotnet
+          sudo rm -rf /usr/share/swift
+          sudo rm -rf "$AGENT_TOOLSDIRECTORY"
+
+          df -h /
       - name: Install Dependencies
         run: |
           sudo apt-get update

.github/workflows/continuous-integration-quality-unit-tests.yml

@@ -7,8 +7,8 @@ jobs:
     name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
     strategy:
       matrix:
-        os: [macOS-latest, ubuntu-latest, windows-2019]
-        python-version: ["3.10", 3.11, 3.12, 3.13]
+        os: [macOS-latest, ubuntu-latest, windows-latest]
+        python-version: [3.11, 3.12, 3.13, 3.14]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -22,10 +22,6 @@ jobs:
           echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
           echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
         shell: bash
-      - name: Set up Python 3.10 for Pre-Commit
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.10"
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
@@ -42,12 +38,13 @@ jobs:
         shell: bash
       - name: Install Package Dependencies
         run: |
-          uv sync --all-extras --no-dev
+          uv sync --all-extras
           uv run python -c "import imageio;imageio.plugins.freeimage.download()"
         shell: bash
-      - name: Pre-Commit (All Files)
+      - name: Prek (All Files)
+        if: matrix.os == 'macOS-latest'
         run: |
-          uv run pre-commit run --all-files
+          uv run prek run --all-files
         shell: bash
       - name: Test Optimised Python Execution
         run: |

.gitignore

@@ -1,21 +1,25 @@
+# Common Files
 *.egg-info
 *.pyc
 *.pyo
 .DS_Store
 .coverage*
-.fleet
-.idea
-.ipynb_checkpoints
+uv.lock
+
+# Common Directories
+.claude/
+.fleet/
+.idea/
+.ipynb_checkpoints/
 .python-version
-.sandbox
-.vs
-.vscode
+.vs/
+.vscode/
+.sandbox/
+build/
+dist/
+docs/_build/
+docs/generated/
+node_modules/
+references/
 
 __pycache__
-
-build
-colour_checker_detection.egg-info
-dist
-docs/_build
-docs/generated
-uv.lock

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.5.0"
+    rev: "v5.0.0"
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -15,31 +15,28 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.4.1
     hooks:
       - id: codespell
+        args: ["--ignore-words-list=socio-economic"]
         exclude: "BIBLIOGRAPHY.bib|CONTRIBUTORS.rst|.*.ipynb"
-  - repo: https://github.com/ikamensh/flynt
-    rev: "1.0.1"
-    hooks:
-      - id: flynt
-        args: [--verbose]
   - repo: https://github.com/PyCQA/isort
-    rev: "5.13.2"
+    rev: "6.0.1"
     hooks:
       - id: isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.14"
+    rev: "v0.12.4"
     hooks:
       - id: ruff-format
       - id: ruff
+        args: [--fix]
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.16.0
+    rev: 1.19.1
     hooks:
       - id: blacken-docs
-        language_version: python3.10
+        language_version: python3.11
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.1.0"
+    rev: "v4.0.0-alpha.8"
     hooks:
       - id: prettier
   - repo: https://github.com/pre-commit/pygrep-hooks

MANIFEST.in

@@ -40,6 +40,7 @@ Features
 The following colour checker detection algorithms are implemented:
 
 -   Segmentation
+-   Templated
 -   Machine learning inference via `Ultralytics YOLOv8 <https://github.com/ultralytics/ultralytics>`__
 
     -   The model is published on `HuggingFace <https://huggingface.co/colour-science/colour-checker-detection-models>`__,
@@ -136,7 +137,8 @@ The *Colour Developers* can be reached via different means:
 - `Facebook <https://www.facebook.com/python.colour.science>`__
 - `Github Discussions <https://github.com/colour-science/colour-checker-detection/discussions>`__
 - `Gitter <https://gitter.im/colour-science/colour>`__
-- `Twitter <https://twitter.com/colour_science>`__
+- `X <https://x.com/colour_science>`__
+- `Bluesky <https://bsky.app/profile/colour-science.bsky.social>`__
 
 About
 -----

README.rst

@@ -6,27 +6,13 @@ TODO
 
 -   colour_checker_detection/__init__.py
 
-    -   Line 90 : # TODO: Remove legacy printing support when deemed appropriate.
+    -   Line 110 : # TODO: Remove legacy printing support when deemed appropriate.
 
 
 -   colour_checker_detection/detection/common.py
 
-    -   Line 126 : # TODO: Update when "Colour" 0.4.5 is released.
-    -   Line 1120 : # TODO: Update when "Colour" 0.4.5 is released.
-
-
--   colour_checker_detection/detection/tests/test_inference.py
-
-    -   Line 58 : # TODO: Unit test is only reproducible on "macOs", skipping other OSes.
-    -   Line 62 : # TODO: Enable when "torch" is available on Python 3.12.
-    -   Line 97 : # TODO: Unit test is only reproducible on "macOs", skipping other OSes.
-    -   Line 101 : # TODO: Enable when "torch" is available on Python 3.12.
-
-
--   colour_checker_detection/detection/tests/test_segmentation.py
-
-    -   Line 57 : # TODO: Unit test is only reproducible on "macOs", skipping other OSes.
-    -   Line 147 : # TODO: Unit test is only reproducible on "macOs", skipping other OSes.
+    -   Line 131 : # TODO: Update when "Colour" 0.4.5 is released.
+    -   Line 1321 : # TODO: Update when "Colour" 0.4.5 is released.
 
 About
 -----