Merge branch 'release/v0.2.1'

colour-science · Oct 12, 2024 · 2892401 · 2892401
2 parents 86055a0 + 07bf5c1
commit 2892401
Show file tree

Hide file tree

Showing 28 changed files with 1,060 additions and 954 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -18,8 +18,8 @@ is available to guide the process: https://www.colour-science.org/contributing/.
 - [ ] Pyright static checking has been run and passed.
 - [ ] Pre-commit hooks have been run and passed.
 
-<!-- The unit tests can be invoked with `poetry run invoke tests` -->
-<!-- Pyright can be started with `pyright --skipunannotated` -->
+<!-- The unit tests can be invoked with `uv run invoke tests` -->
+<!-- Pyright can be started with `pyright --threads --skipunannotated` -->
 
 **Documentation**
 

diff --git a/.github/workflows/continuous-integration-documentation.yml b/.github/workflows/continuous-integration-documentation.yml
@@ -7,12 +7,12 @@ jobs:
     name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
     strategy:
       matrix:
-        os: [ubuntu-22.04]
-        python-version: [3.12]
+        os: [ubuntu-latest]
+        python-version: [3.13]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Environment Variables
         run: |
           echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
@@ -22,27 +22,23 @@ jobs:
           echo "COLOUR_SCIENCE__DOCUMENTATION_BUILD=True" >> $GITHUB_ENV
         shell: bash
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Dependencies
         run: |
           sudo apt-get update
           sudo apt-get --yes install latexmk texlive-full
-      - name: Install Poetry
-        env:
-          POETRY_VERSION: 1.4.0
+      - name: Install uv
         run: |
-          curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
-          echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+          pip install uv
         shell: bash
       - name: Install Package Dependencies
         run: |
-          poetry run python -m pip install --upgrade pip
-          poetry install
-          poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
+          uv sync --all-extras --no-dev
+          uv run python -c "import imageio;imageio.plugins.freeimage.download()"
         shell: bash
       - name: Build Documentation
         run: |
-          poetry run invoke docs
+          uv run invoke docs
         shell: bash
diff --git a/.github/workflows/continuous-integration-quality-unit-tests.yml b/.github/workflows/continuous-integration-quality-unit-tests.yml
@@ -7,12 +7,12 @@ jobs:
     name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
     strategy:
       matrix:
-        os: [macOS-latest, ubuntu-22.04, windows-2019]
-        python-version: [3.9, "3.10", 3.11, 3.12]
+        os: [macOS-latest, ubuntu-latest, windows-2019]
+        python-version: ["3.10", 3.11, 3.12, 3.13]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
         with:
           submodules: true
       - name: Environment Variables
@@ -22,41 +22,43 @@ 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.9 for Pre-Commit
-        uses: actions/setup-python@v4
+      - name: Set up Python 3.10 for Pre-Commit
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install Poetry
-        env:
-          POETRY_VERSION: 1.4.0
+      - name: Install Dependencies (macOS)
+        if: matrix.os == 'macOS-latest'
         run: |
-          curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
-          echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+          brew install freeimage
+          # TODO: Drop when https://github.com/imageio/imageio/issues/628 is addressed
+          echo "IMAGEIO_FREEIMAGE_LIB=/opt/homebrew/Cellar/freeimage/3.18.0/lib/libfreeimage.3.18.0.dylib" >> $GITHUB_ENV
+      - name: Install uv
+        run: |
+          pip install uv
         shell: bash
       - name: Install Package Dependencies
         run: |
-          poetry run python -m pip install --upgrade pip
-          poetry install
-          poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
+          uv sync --all-extras --no-dev
+          uv run python -c "import imageio;imageio.plugins.freeimage.download()"
         shell: bash
       - name: Pre-Commit (All Files)
         run: |
-          poetry run pre-commit run --all-files
+          uv run pre-commit run --all-files
         shell: bash
       - name: Test Optimised Python Execution
         run: |
-          poetry run python -OO -c "import $CI_PACKAGE"
+          uv run python -OO -c "import $CI_PACKAGE"
         shell: bash
       - name: Test with Pytest
         run: |
-          poetry run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --ignore=$CI_PACKAGE/scripts/inference.py --cov=$CI_PACKAGE $CI_PACKAGE
+          uv run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE
         shell: bash
       - name: Upload Coverage to coveralls.io
-        if: matrix.os == 'macOS-latest' && matrix.python-version == '3.11'
+        if: matrix.os == 'macOS-latest' && matrix.python-version == '3.12'
         run: |
-          if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else poetry run coveralls; fi
+          if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else uv run coveralls; fi
         shell: bash
diff --git a/.github/workflows/continuous-integration-static-type-checking.yml b/.github/workflows/continuous-integration-static-type-checking.yml
@@ -12,18 +12,18 @@ jobs:
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Environment Variables
         run: |
           echo "CI_PACKAGE=colour_checker_detection" >> $GITHUB_ENV
         shell: bash
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Package Dependencies
         run: |
-          pip install -r requirements.txt
+          cat requirements.txt | grep -Eo '(^[^#]+)' | xargs -n 1 pip install || true
       - name: Static Type Checking
         run: |
-          pyright --skipunannotated
+          pyright --threads --skipunannotated
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@
 .fleet
 .idea
 .ipynb_checkpoints
+.python-version
 .sandbox
 .vs
 .vscode
@@ -17,4 +18,4 @@ colour_checker_detection.egg-info
 dist
 docs/_build
 docs/generated
-poetry.lock
+uv.lock
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -25,28 +25,23 @@ repos:
       - id: flynt
         args: [--verbose]
   - repo: https://github.com/PyCQA/isort
-    rev: "5.12.0"
+    rev: "5.13.2"
     hooks:
       - id: isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.6"
+    rev: "v0.1.14"
     hooks:
+      - id: ruff-format
       - id: ruff
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.11.0
-    hooks:
-      - id: black
-        language_version: python3.9
   - repo: https://github.com/adamchainz/blacken-docs
     rev: 1.16.0
     hooks:
       - id: blacken-docs
-        language_version: python3.9
+        language_version: python3.10
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v3.1.0"
     hooks:
       - id: prettier
-        exclude: config-aces-reference.ocio.yaml
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: "v1.10.0"
     hooks:

diff --git a/BIBLIOGRAPHY.bib b/BIBLIOGRAPHY.bib
@@ -1,7 +1,29 @@
 @misc{Abecassis2011,
-  title        = {OpenCV - Rotation (Deskewing)},
+  title        = {{{OpenCV}} - {{Rotation}} ({{Deskewing}})},
   author       = {Abecassis, Felix},
   year         = 2011,
-  url          = {http://felix.abecassis.me/2011/10/opencv-rotation-deskewing/},
   urldate      = {2018-10-27},
+  howpublished = {http://felix.abecassis.me/2011/10/opencv-rotation-deskewing/},
+}
+@misc{Dallas2024,
+  title        = {[{{BUG}}]: {{Flipped}} Colour Chart},
+  author       = {Dallas, Jacob},
+  year         = 2024,
+  month        = jan,
+}
+@misc{Olferuk2019,
+  title        = {How to Force {{approxPolyDP}}() to Return Only the
+    Best 4 Corners? - {{Opencv}} 2.4.2},
+  author       = {Olferuk, Alexander},
+  year         = 2019,
+  month        = mar,
+  howpublished = {https://stackoverflow.com/a/55339684/931625},
+}
+@misc{Walter2022,
+  title        = {[{{ENHANCEMENT}}] {{Proposal}} to Allow Detection
+    from Different Perspectives},
+  author       = {Walter, Tim},
+  year         = 2022,
+  urldate      = {2024-01-08},
+  howpublished = {https://github.com/colour-science/colour-checker-detection/issues/60},
 }
diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst
@@ -4,7 +4,7 @@ Contributors
 Development & Technical Support
 -------------------------------
 
--   **Thomas Mansencal**, *Technology Supervisor @ Wētā FX*
+-   **Thomas Mansencal**, *Principal Pipeline Programmer @ Epic Games*
 
     Project coordination, overall development.
 

diff --git a/README.rst b/README.rst
@@ -12,7 +12,7 @@ Colour - Checker Detection
     :target: https://coveralls.io/r/colour-science/colour-checker-detection
     :alt: Coverage Status
 .. |codacy| image:: https://img.shields.io/codacy/grade/c543bc30229347cdaea00aadd3f79499/develop.svg?style=flat-square
-    :target: https://www.codacy.com/app/colour-science/colour-checker-detection
+    :target: https://app.codacy.com/gh/colour-science/colour-checker-detection
     :alt: Code Grade
 .. |version| image:: https://img.shields.io/pypi/v/colour-checker-detection.svg?style=flat-square
     :target: https://pypi.org/project/colour-checker-detection
@@ -44,7 +44,8 @@ The following colour checker detection algorithms are implemented:
 
     -   The model is published on `HuggingFace <https://huggingface.co/colour-science/colour-checker-detection-models>`__,
         and was trained on a purposely constructed `dataset <https://huggingface.co/datasets/colour-science/colour-checker-detection-dataset>`__.
-    -   The model has only been trained on *ColorChecker Classic 24* images and will not work with *ColorChecker Nano* or *ColorChecker SG* images.
+    -   The model has only been trained on *ColorChecker Classic 24* images and
+        will not work with *ColorChecker Nano* or *ColorChecker SG* images.
     -   Inference is performed by a script licensed under the terms of the
         *GNU Affero General Public License v3.0* as it uses the
         *Ultralytics YOLOv8* API which is incompatible with the
@@ -74,16 +75,17 @@ Primary Dependencies
 
 **Colour - Checker Detection** requires various dependencies in order to run:
 
-- `python >= 3.9, < 4 <https://www.python.org/download/releases>`__
-- `colour-science >= 4.3 <https://pypi.org/project/colour-science>`__
+- `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__
+- `colour-science >= 4.5 <https://pypi.org/project/colour-science>`__
 - `imageio >= 2, < 3 <https://imageio.github.io>`__
-- `numpy >= 1.22, < 2 <https://pypi.org/project/numpy>`__
+- `numpy >= 1.24, < 3 <https://pypi.org/project/numpy>`__
 - `opencv-python >= 4, < 5 <https://pypi.org/project/opencv-python>`__
-- `scipy >= 1.8, < 2 <https://pypi.org/project/scipy>`__
+- `scipy >= 1.10, < 2 <https://pypi.org/project/scipy>`__
 
 Secondary Dependencies
 ~~~~~~~~~~~~~~~~~~~~~~
 
+- `click >= 8, < 9 <https://pypi.org/project/click>`__
 - `ultralytics >= 8, < 9 <https://pypi.org/project/ultralytics>`__
 
 Pypi

diff --git a/TODO.rst b/TODO.rst
@@ -6,27 +6,27 @@ TODO
 
 -   colour_checker_detection/__init__.py
 
-    -   Line 92 : # TODO: Remove legacy printing support when deemed appropriate.
+    -   Line 90 : # 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 1131 : # 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 62 : # TODO: Unit test is only reproducible on "macOs", skipping other OSes.
-    -   Line 66 : # TODO: Enable when "torch" is available on Python 3.12.
-    -   Line 101 : # TODO: Unit test is only reproducible on "macOs", skipping other OSes.
-    -   Line 105 : # TODO: Enable when "torch" is available on Python 3.12.
+    -   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 59 : # TODO: Unit test is only reproducible on "macOs", skipping other OSes.
-    -   Line 151 : # TODO: Unit test is only reproducible on "macOs", skipping other OSes.
+    -   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.
 
 About
 -----

diff --git a/colour_checker_detection/__init__.py b/colour_checker_detection/__init__.py
@@ -58,14 +58,14 @@
     ROOT_RESOURCES, "colour-checker-detection-tests-datasets"
 )
 
+__all__ += ["ROOT_RESOURCES", "ROOT_RESOURCES_EXAMPLES", "ROOT_RESOURCES_TESTS"]
+
 __application_name__ = "Colour - Checker Detection"
 
 __major_version__ = "0"
 __minor_version__ = "2"
-__change_version__ = "0"
-__version__ = ".".join(
-    (__major_version__, __minor_version__, __change_version__)
-)
+__change_version__ = "1"
+__version__ = ".".join((__major_version__, __minor_version__, __change_version__))
 
 try:
     _version = (
@@ -83,9 +83,7 @@
 colour.utilities.ANCILLARY_COLOUR_SCIENCE_PACKAGES[  # pyright: ignore
     "colour-checker-detection"
 ] = _version
-colour.utilities.ANCILLARY_RUNTIME_PACKAGES[  # pyright: ignore
-    "opencv"
-] = cv2.__version__
+colour.utilities.ANCILLARY_RUNTIME_PACKAGES["opencv"] = cv2.__version__  # pyright: ignore
 
 del _version