Skip to content

Commit dfbc94c

Browse files
committed
Merge branch 'release/v0.2.5'
2 parents ffba9ce + 3fac8cf commit dfbc94c

26 files changed

+446
-413
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Bug Report
22
description: Report an issue or a bug.
33
title: "[BUG]: << Please use a comprehensive title... >>"
4-
labels: [ Defect ]
4+
labels: [Defect]
55

66
body:
77
- type: markdown

.github/ISSUE_TEMPLATE/documentation-improvement.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Documentation Improvement
22
description: Report a documentation improvement.
33
title: "[DOCUMENTATION]: << Please use a comprehensive title... >>"
4-
labels: [ Documentation ]
4+
labels: [Documentation]
55

66
body:
77
- type: markdown

.github/ISSUE_TEMPLATE/feature-request.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Feature Request
22
description: Suggest a new feature to implement.
33
title: "[FEATURE]: << Please use a comprehensive title... >>"
4-
labels: [ Feature ]
4+
labels: [Feature]
55

66
body:
77
- type: markdown

.github/ISSUE_TEMPLATE/question.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Question
22
description: Ask a question.
33
title: "[DISCUSSION]: << Please use a comprehensive title... >>"
4-
labels: [ Discussion ]
4+
labels: [Discussion]
55

66
body:
77
- type: markdown

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

+35-35
Original file line numberDiff line numberDiff line change
@@ -8,41 +8,41 @@ jobs:
88
strategy:
99
matrix:
1010
os: [ubuntu-22.04]
11-
python-version: [3.11]
11+
python-version: [3.12]
1212
fail-fast: false
1313
runs-on: ${{ matrix.os }}
1414
steps:
15-
- uses: actions/checkout@v1
16-
- name: Environment Variables
17-
run: |
18-
echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
19-
echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
20-
echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
21-
echo "MPLBACKEND=AGG" >> $GITHUB_ENV
22-
echo "COLOUR_SCIENCE__DOCUMENTATION_BUILD=True" >> $GITHUB_ENV
23-
shell: bash
24-
- name: Set up Python ${{ matrix.python-version }}
25-
uses: actions/setup-python@v1
26-
with:
27-
python-version: ${{ matrix.python-version }}
28-
- name: Install Dependencies
29-
run: |
30-
sudo apt-get update
31-
sudo apt-get --yes install latexmk texlive-full
32-
- name: Install Poetry
33-
env:
34-
POETRY_VERSION: 1.4.0
35-
run: |
36-
curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
37-
echo "$HOME/.poetry/bin" >> $GITHUB_PATH
38-
shell: bash
39-
- name: Install Package Dependencies
40-
run: |
41-
poetry run python -m pip install --upgrade pip
42-
poetry install
43-
poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
44-
shell: bash
45-
- name: Build Documentation
46-
run: |
47-
poetry run invoke docs
48-
shell: bash
15+
- uses: actions/checkout@v1
16+
- name: Environment Variables
17+
run: |
18+
echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
19+
echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
20+
echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
21+
echo "MPLBACKEND=AGG" >> $GITHUB_ENV
22+
echo "COLOUR_SCIENCE__DOCUMENTATION_BUILD=True" >> $GITHUB_ENV
23+
shell: bash
24+
- name: Set up Python ${{ matrix.python-version }}
25+
uses: actions/setup-python@v4
26+
with:
27+
python-version: ${{ matrix.python-version }}
28+
- name: Install Dependencies
29+
run: |
30+
sudo apt-get update
31+
sudo apt-get --yes install latexmk texlive-full
32+
- name: Install Poetry
33+
env:
34+
POETRY_VERSION: 1.4.0
35+
run: |
36+
curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
37+
echo "$HOME/.poetry/bin" >> $GITHUB_PATH
38+
shell: bash
39+
- name: Install Package Dependencies
40+
run: |
41+
poetry run python -m pip install --upgrade pip
42+
poetry install
43+
poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
44+
shell: bash
45+
- name: Build Documentation
46+
run: |
47+
poetry run invoke docs
48+
shell: bash

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

+49-49
Original file line numberDiff line numberDiff line change
@@ -8,55 +8,55 @@ jobs:
88
strategy:
99
matrix:
1010
os: [macOS-latest, ubuntu-22.04, windows-latest]
11-
python-version: [3.9, '3.10', 3.11]
11+
python-version: [3.9, "3.10", 3.11, 3.12]
1212
fail-fast: false
1313
runs-on: ${{ matrix.os }}
1414
steps:
15-
- uses: actions/checkout@v1
16-
with:
17-
submodules: true
18-
- name: Environment Variables
19-
run: |
20-
echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
21-
echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
22-
echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
23-
echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
24-
shell: bash
25-
- name: Set up Python 3.9 for Pre-Commit
26-
uses: actions/setup-python@v1
27-
with:
28-
python-version: 3.9
29-
- name: Set up Python ${{ matrix.python-version }}
30-
uses: actions/setup-python@v1
31-
with:
32-
python-version: ${{ matrix.python-version }}
33-
- name: Install Poetry
34-
env:
35-
POETRY_VERSION: 1.4.0
36-
run: |
37-
curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
38-
echo "$HOME/.poetry/bin" >> $GITHUB_PATH
39-
shell: bash
40-
- name: Install Package Dependencies
41-
run: |
42-
poetry run python -m pip install --upgrade pip
43-
poetry install
44-
poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
45-
shell: bash
46-
- name: Pre-Commit (All Files)
47-
run: |
48-
poetry run pre-commit run --all-files
49-
shell: bash
50-
- name: Test Optimised Python Execution
51-
run: |
52-
poetry run python -OO -c "import $CI_PACKAGE"
53-
shell: bash
54-
- name: Test with Pytest
55-
run: |
56-
poetry run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE
57-
shell: bash
58-
- name: Upload Coverage to coveralls.io
59-
if: matrix.os == 'macOS-latest' && matrix.python-version == '3.11'
60-
run: |
61-
if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else poetry run coveralls; fi
62-
shell: bash
15+
- uses: actions/checkout@v1
16+
with:
17+
submodules: true
18+
- name: Environment Variables
19+
run: |
20+
echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
21+
echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
22+
echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
23+
echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
24+
shell: bash
25+
- name: Set up Python 3.9 for Pre-Commit
26+
uses: actions/setup-python@v4
27+
with:
28+
python-version: 3.9
29+
- name: Set up Python ${{ matrix.python-version }}
30+
uses: actions/setup-python@v4
31+
with:
32+
python-version: ${{ matrix.python-version }}
33+
- name: Install Poetry
34+
env:
35+
POETRY_VERSION: 1.4.0
36+
run: |
37+
curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
38+
echo "$HOME/.poetry/bin" >> $GITHUB_PATH
39+
shell: bash
40+
- name: Install Package Dependencies
41+
run: |
42+
poetry run python -m pip install --upgrade pip
43+
poetry install
44+
poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
45+
shell: bash
46+
- name: Pre-Commit (All Files)
47+
run: |
48+
poetry run pre-commit run --all-files
49+
shell: bash
50+
- name: Test Optimised Python Execution
51+
run: |
52+
poetry run python -OO -c "import $CI_PACKAGE"
53+
shell: bash
54+
- name: Test with Pytest
55+
run: |
56+
poetry run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE
57+
shell: bash
58+
- name: Upload Coverage to coveralls.io
59+
if: matrix.os == 'macOS-latest' && matrix.python-version == '3.11'
60+
run: |
61+
if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else poetry run coveralls; fi
62+
shell: bash

.github/workflows/continuous-integration-static-type-checking.yml

+16-16
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ jobs:
88
strategy:
99
matrix:
1010
os: [macOS-latest]
11-
python-version: [3.11]
11+
python-version: [3.12]
1212
fail-fast: false
1313
runs-on: ${{ matrix.os }}
1414
steps:
15-
- uses: actions/checkout@v1
16-
- name: Environment Variables
17-
run: |
18-
echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
19-
shell: bash
20-
- name: Set up Python ${{ matrix.python-version }}
21-
uses: actions/setup-python@v1
22-
with:
23-
python-version: ${{ matrix.python-version }}
24-
- name: Install Package Dependencies
25-
run: |
26-
pip install -r requirements.txt
27-
- name: Static Type Checking
28-
run: |
29-
pyright --skipunannotated
15+
- uses: actions/checkout@v1
16+
- name: Environment Variables
17+
run: |
18+
echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
19+
shell: bash
20+
- name: Set up Python ${{ matrix.python-version }}
21+
uses: actions/setup-python@v4
22+
with:
23+
python-version: ${{ matrix.python-version }}
24+
- name: Install Package Dependencies
25+
run: |
26+
pip install -r requirements.txt
27+
- name: Static Type Checking
28+
run: |
29+
pyright --skipunannotated

.pre-commit-config.yaml

+50-14
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,55 @@
11
repos:
2-
- repo: https://github.com/ikamensh/flynt/
3-
rev: '1.0.1'
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: "v4.5.0"
44
hooks:
5-
- id: flynt
6-
- repo: https://github.com/charliermarsh/ruff-pre-commit
7-
rev: 'v0.0.285'
5+
- id: check-added-large-files
6+
- id: check-case-conflict
7+
- id: check-merge-conflict
8+
- id: check-symlinks
9+
- id: check-yaml
10+
- id: debug-statements
11+
- id: end-of-file-fixer
12+
- id: mixed-line-ending
13+
- id: name-tests-test
14+
args: ["--pytest-test-first"]
15+
- id: requirements-txt-fixer
16+
- id: trailing-whitespace
17+
- repo: https://github.com/codespell-project/codespell
18+
rev: v2.2.6
819
hooks:
9-
- id: ruff
10-
- repo: https://github.com/psf/black
11-
rev: 23.7.0
20+
- id: codespell
21+
exclude: "BIBLIOGRAPHY.bib|CONTRIBUTORS.rst|.*.ipynb"
22+
- repo: https://github.com/ikamensh/flynt
23+
rev: "1.0.1"
1224
hooks:
13-
- id: black
14-
language_version: python3.9
15-
- repo: https://github.com/keewis/blackdoc
16-
rev: v0.3.8
25+
- id: flynt
26+
args: [--verbose]
27+
- repo: https://github.com/PyCQA/isort
28+
rev: "5.12.0"
1729
hooks:
18-
- id: blackdoc
19-
language_version: python3.9
30+
- id: isort
31+
- repo: https://github.com/astral-sh/ruff-pre-commit
32+
rev: "v0.1.6"
33+
hooks:
34+
- id: ruff
35+
- repo: https://github.com/psf/black-pre-commit-mirror
36+
rev: 23.11.0
37+
hooks:
38+
- id: black
39+
language_version: python3.9
40+
- repo: https://github.com/adamchainz/blacken-docs
41+
rev: 1.16.0
42+
hooks:
43+
- id: blacken-docs
44+
language_version: python3.9
45+
- repo: https://github.com/pre-commit/mirrors-prettier
46+
rev: "v3.1.0"
47+
hooks:
48+
- id: prettier
49+
exclude: config-aces-reference.ocio.yaml
50+
- repo: https://github.com/pre-commit/pygrep-hooks
51+
rev: "v1.10.0"
52+
hooks:
53+
- id: rst-backticks
54+
- id: rst-directive-colons
55+
- id: rst-inline-touching-normal

.readthedocs.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ build:
66
python: "3.11"
77

88
sphinx:
9-
configuration: docs/conf.py
9+
configuration: docs/conf.py
1010

1111
formats:
1212
- htmlzip
1313
- pdf
1414

1515
python:
1616
install:
17-
- requirements: docs/requirements.txt
17+
- requirements: docs/requirements.txt

CODE_OF_CONDUCT.md

+11-14
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,22 @@ In the interest of fostering an open and welcoming environment, we as contributo
88

99
Examples of behavior that contributes to creating a positive environment include:
1010

11-
* Using welcoming and inclusive language
12-
* Being respectful of differing viewpoints and experiences
13-
* Gracefully accepting constructive criticism
14-
* Focusing on what is best for the community
15-
* Showing empathy towards other community members
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
1616

1717
Examples of unacceptable behavior by participants include:
1818

19-
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20-
* Trolling, insulting/derogatory comments, and personal or political attacks
21-
* Public or private harassment
22-
* Publishing others’ private information, such as a physical or electronic address, without explicit permission
23-
* Other conduct which could reasonably be considered inappropriate in a professional setting
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others’ private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
2424

2525
## Our Responsibilities
2626

27-
2827
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
2928

3029
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
@@ -35,7 +34,6 @@ This Code of Conduct applies within all project spaces, and it also applies when
3534

3635
## Enforcement
3736

38-
3937
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting Thomas Mansencal and Michael Mauderer via email at thomas@colour-science.org and michael@colour-science.org respectively. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
4038

4139
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
@@ -46,6 +44,5 @@ This Code of Conduct is adapted from the Contributor Covenant, version 1.4, avai
4644

4745
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq][faq].
4846

49-
5047
[homepage]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
51-
[faq]: https://www.contributor-covenant.org/faq
48+
[faq]: https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)