Merge branch 'release/v0.2.0'

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,43 @@
+name: Bug Report
+description: Report an issue or a bug.
+title: "[BUG]: << Please use a comprehensive title... >>"
+labels: [ Defect ]
+
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thank you for taking the time to file a bug report. Before continuing, please take some time to check the existing [issues](https://github.com/colour-science/colour-demosaicing/issues).
+        The issue could already be fixed in the [develop](https://github.com/colour-science/colour-demosaicing) branch. If you have an installation problem, the [installation guide](https://www.colour-science.org/installation-guide/) describes the recommended process.
+
+  - type: textarea
+    attributes:
+      label: "Description"
+      description: >
+        Please describe the issue in a few short sentences.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Code for Reproduction"
+      description: >
+        If possible, please provide a minimum self-contained example reproducing the issue.
+      placeholder: |
+        << Your code here... >>
+      render: python
+
+  - type: textarea
+    attributes:
+      label: "Exception Message"
+      description: >
+        If any, please paste the *full* exception message.
+      placeholder: |
+        << Full traceback starting from `Traceback (most recent call last):`... >>
+      render: shell
+
+  - type: textarea
+    attributes:
+      label: "Environment Information"
+      description: If possible, please paste the output from `import colour; colour.utilities.describe_environment()`.
+      render: shell

.github/ISSUE_TEMPLATE/documentation-improvement.yml

@@ -0,0 +1,40 @@
+name: Documentation Improvement
+description: Report a documentation improvement.
+title: "[DOCUMENTATION]: << Please use a comprehensive title... >>"
+labels: [ Documentation ]
+
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thank you for taking the time to file a documentation improvement report. Before continuing, please take some time to check the existing [issues](https://github.com/colour-science/colour-demosaicing/issues).
+
+  - type: input
+    attributes:
+      label: Documentation Link
+      description: >
+        Please link to any documentation or examples that you are referencing. Suggested improvements should be based on the [development version of the documentation](https://colour-demosaicing.readthedocs.io/en/develop/).
+      placeholder: >
+        << https://colour-demosaicing.readthedocs.io/en/develop/... >>
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: >
+        Please describe what is missing, unclear or incorrect.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Suggested Improvement
+      description: >
+        Please describe how the documentation could be improved.
+
+  - type: textarea
+    attributes:
+      label: "Environment Information"
+      description: If possible, please paste the output from `import colour; colour.utilities.describe_environment()`.
+      render: shell

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,18 @@
+name: Feature Request
+description: Suggest a new feature to implement.
+title: "[FEATURE]: << Please use a comprehensive title... >>"
+labels: [ Feature ]
+
+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-demosaicing/issues) and also the [draft release notes](https://gist.github.com/KelSolaar/4a6ebe9ec3d389f0934b154fec8df51d).
+
+  - type: textarea
+    attributes:
+      label: "Description"
+      description: >
+        Please describe the new feature in a few short sentences.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,17 @@
+name: Question
+description: Ask a question.
+title: "[DISCUSSION]: << Please use a comprehensive title... >>"
+labels: [ Discussion ]
+
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to ask a question or discuss. Before continuing, we would be glad if you were to start this discussion in the dedicated [discussions](https://github.com/colour-science/colour-demosaicing/discussions) area.
+
+  - type: textarea
+    attributes:
+      label: "Question"
+      description: >
+        If you are still here, please consider using the dedicated [discussions](https://github.com/colour-science/colour-demosaicing/discussions) area.
+      placeholder: >
+        << The discussions area is this way: https://github.com/colour-science/colour-demosaicing/discussions...  >>

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!--
+Thank you for taking the time to create this pull request. If it is the first
+time you are contributing to a colour-science repository, a contributing guide
+is available to guide the process: https://www.colour-science.org/contributing/.
+-->
+
+# Summary
+
+<!-- Please write a summary describing the changes that this PR implements. -->
+
+# Preflight
+
+<!-- Please mark any checkboxes that do not apply to this pull request as [N/A]. -->
+
+**Code Style and Quality**
+
+- [ ] Unit tests have been implemented and passed.
+- [ ] Mypy 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` -->
+<!-- Mypy can be started with `dmypy run -- --show-error-codes --warn-unused-ignores --warn-redundant-casts --install-types --non-interactive -p colour-demosaicing` -->
+
+**Documentation**
+
+- [ ] New features are documented along with examples if relevant.
+- [ ] The documentation is [Sphinx](https://www.sphinx-doc.org/en/master/) and [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant.
+
+<!--
+Thank you again!
+-->

.github/funding.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: colour-science # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

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

@@ -0,0 +1,47 @@
+name: Continuous Integration - Documentation
+
+on: [push, pull_request]
+
+jobs:
+  continuous-integration-documentation:
+    name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
+    strategy:
+      matrix:
+        os: [ubuntu-20.04]
+        python-version: [3.8]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v1
+    - name: Environment Variables
+      run: |
+        echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
+        echo "CI_PACKAGE=colour" >> $GITHUB_ENV
+        echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
+        echo "MPLBACKEND=AGG" >> $GITHUB_ENV
+        echo "COLOUR_SCIENCE__DOCUMENTATION_BUILD=True" >> $GITHUB_ENV
+      shell: bash
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      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
+      run: |
+        curl -L https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py -o get-poetry.py
+        python get-poetry.py
+        echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+      shell: bash
+    - name: Install Package Dependencies
+      run: |
+        poetry run python -m pip install --upgrade pip
+        poetry install --extras "read-the-docs"
+        poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
+      shell: bash
+    - name: Build Documentation
+      run: |
+        poetry run invoke docs
+      shell: bash

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

@@ -1,14 +1,14 @@
-name: Continuous Integration
+name: Continuous Integration - Quality & Unit Tests
 
 on: [push, pull_request]
 
 jobs:
-  continuous-integration:
+  continuous-integration-package:
     name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
     strategy:
       matrix:
-        os: [macOS-latest, ubuntu-18.04, windows-latest]
-        python-version: [2.7, 3.6, 3.7, 3.8]
+        os: [macOS-latest, ubuntu-20.04, windows-latest]
+        python-version: [3.8, 3.9, '3.10']
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -35,40 +35,28 @@ jobs:
     - name: Install Poetry
       run: |
         curl -L https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py -o get-poetry.py
-        python get-poetry.py --version 1.0.10
+        python get-poetry.py --version 1.1.12
         echo "$HOME/.poetry/bin" >> $GITHUB_PATH
       shell: bash
-    - name: Update pyproject.toml file (Python 2.7)
-      if: matrix.python-version == '2.7'
-      run: |
-        sed -i.bak 's/python = "~2.7 || ^3.6"/python = "~2.7"/g' pyproject.toml
-        sed -i.bak '/colour-science = "\^0\.3\.16"/ a qtconsole = "4.7.7"' pyproject.toml
-      shell: bash
-    - name: Update pyproject.toml file (Python 3.x)
-      if: matrix.python-version != '2.7'
-      run: |
-        sed -i.bak 's/python = "~2.7 || ^3.6"/python = "^3.6"/g' pyproject.toml
-      shell: bash
-    - name: Update pyproject.toml file (Windows, Python 2.7)
-      if: matrix.os == 'windows-latest' && matrix.python-version == '2.7'
-      run: |
-        sed -i.bak '/colour-science = "\^0\.3\.16"/ a pywin32 = "228"' pyproject.toml
-      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()"
       shell: bash
-    - name: Lint with flake8
+    - name: Pre-Commit (All Files)
+      run: |
+        poetry run pre-commit run --all-files
+      shell: bash
+    - name: Test Optimised Python Execution
       run: |
-        poetry run flake8 $CI_PACKAGE --count --show-source --statistics
+        poetry run python -OO -c "import $CI_PACKAGE"
       shell: bash
-    - name: Test with nosetests
+    - name: Test with Pytest
       run: |
-        poetry run python -W ignore -m nose -q -v --with-doctest --doctest-options=+ELLIPSIS --with-coverage --cover-package=$CI_PACKAGE $CI_PACKAGE
+        poetry run python -W ignore -m py.test --disable-warnings --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE
       shell: bash
     - name: Upload Coverage to coveralls.io
-      if: matrix.python-version == '3.6' || matrix.python-version == '3.7'
       run: |
         if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else poetry run coveralls; fi
       shell: bash

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

@@ -0,0 +1,32 @@
+name: Continuous Integration - Static Type Checking
+
+on: [push, pull_request]
+
+jobs:
+  continuous-integration-package:
+    name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
+    strategy:
+      matrix:
+        os: [macOS-latest]
+        python-version: [3.9]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v1
+    - name: Environment Variables
+      run: |
+        echo "CI_PACKAGE=colour" >> $GITHUB_ENV
+      shell: bash
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies (macOS)
+      run: |
+        brew install gnu-sed graphviz
+        ln -s /usr/local/bin/gsed /usr/local/bin/sed
+      shell: bash
+    - name: Static Type Checking
+      run: |
+        pip install -r requirements.txt
+        mypy --install-types --non-interactive --show-error-codes --warn-unused-ignores --warn-redundant-casts -p $CI_PACKAGE

.gitignore

@@ -1,8 +1,10 @@
 *.pyc
 .DS_Store
 .coverage
+.dmypy.json
 .idea
 .ipynb_checkpoints/
+.mypy_cache
 __pycache__
 build
 colour_demosaicing.egg-info

.pre-commit-config.yaml

@@ -1,11 +1,26 @@
 repos:
--   repo: https://gitlab.com/pycqa/flake8
-    rev: 3.7.8
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.0
+    hooks:
+    -   id: pyupgrade
+        args: [--py38-plus]
+-   repo: https://github.com/ikamensh/flynt/
+    rev: '0.76'
+    hooks:
+    -   id: flynt
+-   repo: https://github.com/psf/black
+    rev: 22.1.0
+    hooks:
+    - id: black
+      language_version: python3.8
+-   repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
     hooks:
     -   id: flake8
-        exclude: examples|setup\.py
--   repo: https://github.com/pre-commit/mirrors-yapf
-    rev: v0.23.0
+-   repo: https://github.com/pycqa/pydocstyle
+    rev: 6.1.1
     hooks:
-    -   id: yapf
-        exclude: setup\.py
+    -   id: pydocstyle
+        args:
+        - --convention=numpy
+        - --add-ignore=D104,D200,D202,D205,D301,D400

.readthedocs.yaml

@@ -0,0 +1,20 @@
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.8"
+
+sphinx:
+   configuration: docs/conf.py
+
+formats:
+  - htmlzip
+  - pdf
+
+python:
+   install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - read-the-docs