Merge branch 'feature/v0.1.3' into develop

Author: KelSolaar

.pre-commit-config.yaml

@@ -17,3 +17,10 @@ repos:
     rev: 4.0.1
     hooks:
     -   id: flake8
+-   repo: https://github.com/pycqa/pydocstyle
+    rev: 6.1.1
+    hooks:
+    -   id: pydocstyle
+        args:
+        - --convention=numpy
+        - --add-ignore=D104,D200,D202,D205,D301,D400

colour_checker_detection/detection/segmentation.py

@@ -145,9 +145,7 @@
 """
 
 FLOAT_DTYPE_DEFAULT: Type[DTypeFloating] = np.float32
-"""
-Dtype used for the computations.
-"""
+"""Dtype used for the computations."""
 
 
 @dataclass

pyproject.toml

@@ -61,6 +61,7 @@ mypy = { version = "*", optional = true }  # Development dependency.
 numpy = { version = ">= 1.19, < 2", optional = true }
 pre-commit = { version = "*", optional = true }  # Development dependency.
 pydata-sphinx-theme = { version = "*", optional = true }  # Development dependency.
+pydocstyle = { version = "*", optional = true }  # Development dependency.
 pytest = { version = "*", optional = true }  # Development dependency.
 pytest-cov = { version = "*", optional = true }  # Development dependency.
 pyupgrade = { version = "*", optional = true }  # Development dependency.
@@ -82,6 +83,7 @@ jupyter = "*"
 mypy = "*"
 pre-commit = "*"
 pydata-sphinx-theme = "*"
+pydocstyle = "*"
 pytest = "*"
 pytest-cov = "*"
 pyupgrade = "*"
@@ -104,6 +106,7 @@ development = [
     "mypy",
     "pre-commit",
     "pydata-sphinx-theme",
+    "pydocstyle",
     "pytest",
     "pytest-cov",
     "pyupgrade",
@@ -139,6 +142,10 @@ line_length=999
 plugins = "numpy.typing.mypy_plugin"
 ignore_missing_imports = true
 
+[tool.pydocstyle]
+convention = "numpy"
+add-ignore = "D104,D200,D202,D205,D301,D400"
+
 [build-system]
 requires = [ "poetry>=0.12" ]
 build-backend = "poetry.masonry.api"

setup.py

@@ -1,55 +1,65 @@
-# -*- coding: utf-8 -*-
+"""
+Colour - Checker Detection - Setup
+==================================
+"""
+
 import codecs
 from setuptools import setup
 
-packages = \
-['colour_checker_detection',
- 'colour_checker_detection.detection',
- 'colour_checker_detection.detection.tests']
+packages = [
+    "colour_checker_detection",
+    "colour_checker_detection.detection",
+    "colour_checker_detection.detection.tests",
+]
 
-package_data = \
-{'': ['*'],
- 'colour_checker_detection': ['examples/*',
-                              'resources/colour-checker-detection-examples-datasets/*',
-                              'resources/colour-checker-detection-tests-datasets/*']}
+package_data = {
+    "": ["*"],
+    "colour_checker_detection": [
+        "examples/*",
+        "resources/colour-checker-detection-examples-datasets/*",
+        "resources/colour-checker-detection-tests-datasets/*",
+    ],
+}
 
-install_requires = \
-['colour-science>=0.3.16,<0.4.0', 'opencv-python>=4,<5']
+install_requires = ["colour-science>=0.3.16,<0.4.0", "opencv-python>=4,<5"]
 
-extras_require = \
-{'development': ['biblib-simple',
-                 'coverage',
-                 'coveralls',
-                 'flake8',
-                 'invoke',
-                 'jupyter',
-                 'matplotlib',
-                 'mock',
-                 'nose',
-                 'pre-commit',
-                 'pytest',
-                 'restructuredtext-lint',
-                 'sphinx<=3.1.2',
-                 'sphinx_rtd_theme',
-                 'sphinxcontrib-bibtex',
-                 'toml',
-                 'twine',
-                 'yapf==0.23'],
- 'read-the-docs': ['mock', 'numpy', 'sphinxcontrib-bibtex']}
+extras_require = {
+    "development": [
+        "biblib-simple",
+        "coverage",
+        "coveralls",
+        "flake8",
+        "invoke",
+        "jupyter",
+        "matplotlib",
+        "mock",
+        "nose",
+        "pre-commit",
+        "pytest",
+        "restructuredtext-lint",
+        "sphinx<=3.1.2",
+        "sphinx_rtd_theme",
+        "sphinxcontrib-bibtex",
+        "toml",
+        "twine",
+        "yapf==0.23",
+    ],
+    "read-the-docs": ["mock", "numpy", "sphinxcontrib-bibtex"],
+}
 
 setup(
-    name='colour-checker-detection',
-    version='0.1.2',
-    description='Colour checker detection with Python',
-    long_description=codecs.open('README.rst', encoding='utf8').read(),
-    author='Colour Developers',
-    author_email='colour-developers@colour-science.org',
-    maintainer='Colour Developers',
-    maintainer_email='colour-developers@colour-science.org',
-    url='https://www.colour-science.org/',
+    name="colour-checker-detection",
+    version="0.1.2",
+    description="Colour checker detection with Python",
+    long_description=codecs.open("README.rst", encoding="utf8").read(),
+    author="Colour Developers",
+    author_email="colour-developers@colour-science.org",
+    maintainer="Colour Developers",
+    maintainer_email="colour-developers@colour-science.org",
+    url="https://www.colour-science.org/",
     packages=packages,
     package_data=package_data,
     install_requires=install_requires,
     extras_require=extras_require,
-    python_requires='>=3.6,<4.0',
+    python_requires=">=3.6,<4.0",
 )

tasks.py

@@ -1,5 +1,4 @@
-"""
-Invoke - Tasks
+"""Invoke - Tasks
 ==============
 """
 
@@ -59,9 +58,7 @@
 
 
 def _patch_invoke_annotations_support():
-    """
-    See https://github.com/pyinvoke/invoke/issues/357
-    """
+    """See https://github.com/pyinvoke/invoke/issues/357."""
 
     import invoke
     from unittest.mock import patch
@@ -93,8 +90,7 @@ def clean(
     mypy: Boolean = True,
     pytest: Boolean = True,
 ):
-    """
-    Clean the project.
+    """Clean the project.
 
     Parameters
     ----------
@@ -138,8 +134,7 @@ def formatting(
     asciify: Boolean = True,
     bibtex: Boolean = True,
 ):
-    """
-    Convert unicode characters to ASCII and cleanup the *BibTeX* file.
+    """Convert unicode characters to ASCII and cleanup the *BibTeX* file.
 
     Parameters
     ----------
@@ -185,8 +180,7 @@ def quality(
     mypy: Boolean = True,
     rstlint: Boolean = True,
 ):
-    """
-    Check the codebase with *Mypy* and lints various *restructuredText*
+    """Check the codebase with *Mypy* and lints various *restructuredText*
     files with *rst-lint*.
 
     Parameters
@@ -221,8 +215,7 @@ def quality(
 
 @task
 def precommit(ctx: Context):
-    """
-    Run the "pre-commit" hooks on the codebase.
+    """Run the "pre-commit" hooks on the codebase.
 
     Parameters
     ----------
@@ -236,8 +229,7 @@ def precommit(ctx: Context):
 
 @task
 def tests(ctx: Context):
-    """
-    Run the unit tests with *Pytest*.
+    """Run the unit tests with *Pytest*.
 
     Parameters
     ----------
@@ -258,8 +250,7 @@ def tests(ctx: Context):
 
 @task
 def examples(ctx: Context):
-    """
-    Run the examples.
+    """Run the examples.
 
     Parameters
     ----------
@@ -278,8 +269,7 @@ def examples(ctx: Context):
 
 @task(formatting, quality, precommit, tests, examples)
 def preflight(ctx: Context):
-    """
-    Perform the preflight tasks, i.e., *formatting*, *tests*, *quality*, and
+    """Perform the preflight tasks, i.e., *formatting*, *tests*, *quality*, and
     *examples*.
 
     Parameters
@@ -293,8 +283,7 @@ def preflight(ctx: Context):
 
 @task
 def docs(ctx: Context, html: Boolean = True, pdf: Boolean = True):
-    """
-    Build the documentation.
+    """Build the documentation.
 
     Parameters
     ----------
@@ -319,8 +308,7 @@ def docs(ctx: Context, html: Boolean = True, pdf: Boolean = True):
 
 @task
 def todo(ctx: Context):
-    """
-    Export the TODO items.
+    """Export the TODO items.
 
     Parameters
     ----------
@@ -336,8 +324,7 @@ def todo(ctx: Context):
 
 @task
 def requirements(ctx: Context):
-    """
-    Export the *requirements.txt* file.
+    """Export the *requirements.txt* file.
 
     Parameters
     ----------
@@ -355,8 +342,7 @@ def requirements(ctx: Context):
 
 @task(clean, preflight, docs, todo, requirements)
 def build(ctx: Context):
-    """
-    Build the project and runs dependency tasks, i.e., *docs*, *todo*, and
+    """Build the project and runs dependency tasks, i.e., *docs*, *todo*, and
     *preflight*.
 
     Parameters
@@ -420,8 +406,7 @@ def sub_callable(match):
 
 @task
 def virtualise(ctx: Context, tests: Boolean = True):
-    """
-    Create a virtual environment for the project build.
+    """Create a virtual environment for the project build.
 
     Parameters
     ----------
@@ -449,8 +434,7 @@ def virtualise(ctx: Context, tests: Boolean = True):
 
 @task
 def tag(ctx: Context):
-    """
-    Tag the repository according to defined version using *git-flow*.
+    """Tag the repository according to defined version using *git-flow*.
 
     Parameters
     ----------
@@ -498,8 +482,7 @@ def tag(ctx: Context):
 
 @task(build)
 def release(ctx: Context):
-    """
-    Release the project to *Pypi* with *Twine*.
+    """Release the project to *Pypi* with *Twine*.
 
     Parameters
     ----------
@@ -515,8 +498,7 @@ def release(ctx: Context):
 
 @task
 def sha256(ctx: Context):
-    """
-    Compute the project *Pypi* package *sha256* with *OpenSSL*.
+    """Compute the project *Pypi* package *sha256* with *OpenSSL*.
 
     Parameters
     ----------