Skip to content

Commit

Permalink
Use *uv* and *hatch* and enable *Python* 3.13.
Browse files Browse the repository at this point in the history
  • Loading branch information
KelSolaar committed Oct 12, 2024
1 parent 93ab024 commit 7fb3b74
Show file tree
Hide file tree
Showing 15 changed files with 439 additions and 342 deletions.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down
14 changes: 6 additions & 8 deletions .github/workflows/continuous-integration-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
python-version: [3.12]
python-version: [3.13]
fail-fast: false
runs-on: ${{ matrix.os }}
steps:
Expand All @@ -29,18 +29,16 @@ jobs:
run: |
sudo apt-get update
sudo apt-get --yes install latexmk texlive-full
- name: Install Poetry
- 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
30 changes: 17 additions & 13 deletions .github/workflows/continuous-integration-quality-unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-2019]
python-version: [3.9, "3.10", 3.11, 3.12]
python-version: ["3.10", 3.11, 3.12, 3.13]
fail-fast: false
runs-on: ${{ matrix.os }}
steps:
Expand All @@ -22,39 +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
- 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@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Poetry
- 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.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
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
.fleet
.idea
.ipynb_checkpoints
.python-version
.sandbox
.vs
.vscode
Expand All @@ -17,4 +18,4 @@ colour_checker_detection.egg-info
dist
docs/_build
docs/generated
poetry.lock
uv.lock
9 changes: 5 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,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
Expand Down
16 changes: 8 additions & 8 deletions TODO.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down
7 changes: 3 additions & 4 deletions colour_checker_detection/detection/inference.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
from colour.utilities import (
Structure,
as_int_scalar,
is_string,
)
from colour.utilities.documentation import (
DocstringDict,
Expand Down Expand Up @@ -193,7 +192,7 @@ def inferencer_default(
temp_directory = tempfile.mkdtemp()

try:
if not is_string(image):
if not isinstance(image, str):
input_image = os.path.join(temp_directory, "input-image.png")

if apply_cctf_encoding:
Expand Down Expand Up @@ -366,8 +365,8 @@ def detect_colour_checkers_inference(

results = inferencer(image, **inferencer_kwargs)

if is_string(image):
image = read_image(cast(str, image))
if isinstance(image, str):
image = read_image(image)
else:
image = convert_bit_depth(
image,
Expand Down
5 changes: 2 additions & 3 deletions colour_checker_detection/detection/segmentation.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
from colour.utilities import (
MixinDataclassIterable,
Structure,
is_string,
)
from colour.utilities.documentation import (
DocstringDict,
Expand Down Expand Up @@ -541,8 +540,8 @@ def detect_colour_checkers_segmentation(
working_width = settings.working_width
working_height = int(working_width / settings.aspect_ratio)

if is_string(image):
image = read_image(cast(str, image))
if isinstance(image, str):
image = read_image(image)
else:
image = convert_bit_depth(
image,
Expand Down
2 changes: 1 addition & 1 deletion colour_checker_detection/scripts/inference.py
Original file line number Diff line number Diff line change
Expand Up @@ -232,4 +232,4 @@ def segmentation(
if __name__ == "__main__":
logging.basicConfig()

segmentation() # pyright: ignore
segmentation()
9 changes: 5 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ Primary Dependencies

**Colour - Checker Detection** requires various dependencies in order to run:

- `python >= 3.8, < 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
Expand Down
133 changes: 82 additions & 51 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,51 +1,82 @@
accessible-pygments==0.0.4 ; python_version >= "3.9" and python_version < "3.13"
alabaster==0.7.16 ; python_version >= "3.9" and python_version < "3.13"
babel==2.14.0 ; python_version >= "3.9" and python_version < "3.13"
beautifulsoup4==4.12.2 ; python_version >= "3.9" and python_version < "3.13"
biblib-simple==0.1.2 ; python_version >= "3.9" and python_version < "3.13"
certifi==2023.11.17 ; python_version >= "3.9" and python_version < "3.13"
charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "3.13"
colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "win32"
colour-science==0.4.4 ; python_version >= "3.9" and python_version < "3.13"
contourpy==1.2.0 ; python_version >= "3.9" and python_version < "3.13"
cycler==0.12.1 ; python_version >= "3.9" and python_version < "3.13"
docutils==0.20.1 ; python_version >= "3.9" and python_version < "3.13"
fonttools==4.47.0 ; python_version >= "3.9" and python_version < "3.13"
idna==3.6 ; python_version >= "3.9" and python_version < "3.13"
imageio==2.33.1 ; python_version >= "3.9" and python_version < "3.13"
imagesize==1.4.1 ; python_version >= "3.9" and python_version < "3.13"
importlib-metadata==7.0.1 ; python_version >= "3.9" and python_version < "3.10"
importlib-resources==6.1.1 ; python_version >= "3.9" and python_version < "3.10"
jinja2==3.1.3 ; python_version >= "3.9" and python_version < "3.13"
kiwisolver==1.4.5 ; python_version >= "3.9" and python_version < "3.13"
latexcodec==2.0.1 ; python_version >= "3.9" and python_version < "3.13"
markupsafe==2.1.3 ; python_version >= "3.9" and python_version < "3.13"
matplotlib==3.8.2 ; python_version >= "3.9" and python_version < "3.13"
numpy==1.26.3 ; python_version >= "3.9" and python_version < "3.13"
opencv-python==4.9.0.80 ; python_version >= "3.9" and python_version < "3.13"
packaging==23.2 ; python_version >= "3.9" and python_version < "3.13"
pillow==10.2.0 ; python_version >= "3.9" and python_version < "3.13"
pybtex==0.24.0 ; python_version >= "3.9" and python_version < "3.13"
pybtex-docutils==1.0.3 ; python_version >= "3.9" and python_version < "3.13"
pydata-sphinx-theme==0.15.1 ; python_version >= "3.9" and python_version < "3.13"
pygments==2.17.2 ; python_version >= "3.9" and python_version < "3.13"
pyparsing==3.1.1 ; python_version >= "3.9" and python_version < "3.13"
python-dateutil==2.8.2 ; python_version >= "3.9" and python_version < "3.13"
pyyaml==6.0.1 ; python_version >= "3.9" and python_version < "3.13"
requests==2.31.0 ; python_version >= "3.9" and python_version < "3.13"
restructuredtext-lint==1.4.0 ; python_version >= "3.9" and python_version < "3.13"
scipy==1.11.4 ; python_version >= "3.9" and python_version < "3.13"
six==1.16.0 ; python_version >= "3.9" and python_version < "3.13"
snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "3.13"
soupsieve==2.5 ; python_version >= "3.9" and python_version < "3.13"
sphinx==7.2.6 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-applehelp==1.0.7 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-bibtex==2.6.2 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-devhelp==1.0.5 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-htmlhelp==2.0.4 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-qthelp==1.0.6 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-serializinghtml==1.1.9 ; python_version >= "3.9" and python_version < "3.13"
typing-extensions==4.9.0 ; python_version >= "3.9" and python_version < "3.13"
urllib3==2.1.0 ; python_version >= "3.9" and python_version < "3.13"
zipp==3.17.0 ; python_version >= "3.9" and python_version < "3.10"
# This file was autogenerated by uv via the following command:
# uv export --no-hashes --all-extras --no-dev
accessible-pygments==0.0.5
alabaster==1.0.0
babel==2.16.0
beautifulsoup4==4.12.3
biblib-simple==0.1.2
certifi==2024.8.30
charset-normalizer==3.4.0
click==8.1.7 ; python_full_version < '3.13'
colorama==0.4.6 ; (platform_system != 'Windows' and sys_platform == 'win32') or (python_full_version < '3.13' and platform_system == 'Windows') or (python_full_version >= '3.13' and sys_platform == 'win32')
colour-science==0.4.6
contourpy==1.3.0
cycler==0.12.1
docutils==0.21.2
filelock==3.16.1 ; python_full_version < '3.13'
fonttools==4.54.1
fsspec==2024.9.0 ; python_full_version < '3.13'
idna==3.10
imageio==2.35.1
imagesize==1.4.1
jinja2==3.1.4
kiwisolver==1.4.7
latexcodec==3.0.0
markupsafe==3.0.1
matplotlib==3.9.2
mpmath==1.3.0 ; python_full_version < '3.13'
networkx==3.4.1 ; python_full_version < '3.13'
numpy==2.1.2
nvidia-cublas-cu12==12.1.3.1 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-cuda-cupti-cu12==12.1.105 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-cuda-nvrtc-cu12==12.1.105 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-cuda-runtime-cu12==12.1.105 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-cudnn-cu12==9.1.0.70 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-cufft-cu12==11.0.2.54 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-curand-cu12==10.3.2.106 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-cusolver-cu12==11.4.5.107 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-cusparse-cu12==12.1.0.106 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-nccl-cu12==2.20.5 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-nvjitlink-cu12==12.6.77 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
nvidia-nvtx-cu12==12.1.105 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
opencv-python==4.10.0.84
packaging==24.1
pandas==2.2.3 ; python_full_version < '3.13'
pillow==10.4.0
psutil==6.0.0 ; python_full_version < '3.13'
py-cpuinfo==9.0.0 ; python_full_version < '3.13'
pybtex==0.24.0
pybtex-docutils==1.0.3
pydata-sphinx-theme==0.15.4
pygments==2.18.0
pyparsing==3.1.4
python-dateutil==2.9.0.post0
pytz==2024.2 ; python_full_version < '3.13'
pyyaml==6.0.2
requests==2.32.3
restructuredtext-lint==1.4.0
scipy==1.14.1
seaborn==0.13.2 ; python_full_version < '3.13'
setuptools==75.1.0 ; python_full_version >= '3.12'
six==1.16.0
snowballstemmer==2.2.0
soupsieve==2.6
sphinx==8.1.2
sphinxcontrib-applehelp==2.0.0
sphinxcontrib-bibtex==2.6.3
sphinxcontrib-devhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==2.0.0
sphinxcontrib-serializinghtml==2.0.0
sympy==1.13.3 ; python_full_version < '3.13'
tomli==2.0.2 ; python_full_version < '3.11'
torch==2.4.1 ; python_full_version < '3.13'
torchvision==0.19.1 ; python_full_version < '3.13'
tqdm==4.66.5 ; python_full_version < '3.13'
triton==3.0.0 ; python_full_version < '3.13' and platform_machine == 'x86_64' and platform_system == 'Linux'
typing-extensions==4.12.2
tzdata==2024.2 ; python_full_version < '3.13'
ultralytics==8.3.11 ; python_full_version < '3.13'
ultralytics-thop==2.0.9 ; python_full_version < '3.13'
urllib3==2.2.3
Loading

0 comments on commit 7fb3b74

Please sign in to comment.