Merge branch 'feature/v0.1.3' into develop

Author: KelSolaar

CONTRIBUTORS.rst

@@ -16,6 +16,6 @@ About
 -----
 
 | **Colour - Checker Detection** by Colour Developers
-| Copyright © 2018-2021 – Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
+| Copyright 2018 Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
 | This software is released under terms of New BSD License: https://opensource.org/licenses/BSD-3-Clause
 | `https://github.com/colour-science/colour-checker-detection <https://github.com/colour-science/colour-checker-detection>`__

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018-2021, Colour Developers
+Copyright 2018 Colour Developers
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.rst

@@ -31,7 +31,7 @@ It is open source and freely available under the
 
 .. contents:: **Table of Contents**
     :backlinks: none
-    :depth: 3
+    :depth: 2
 
 .. sectnum::
 
@@ -42,8 +42,17 @@ The following colour checker detection algorithms are implemented:
 
 - Segmentation
 
+Examples
+^^^^^^^^
+
+Various usage examples are available from the
+`examples directory <https://github.com/colour-science/colour-checker-detection/tree/master/colour_checker_detection/examples>`__.
+
+User Guide
+----------
+
 Installation
-------------
+^^^^^^^^^^^^
 
 Because of their size, the resources dependencies needed to run the various
 examples and unit tests are not provided within the Pypi package. They are
@@ -53,16 +62,16 @@ when cloning the
 `repository <https://github.com/colour-science/colour-checker-detection>`__.
 
 Primary Dependencies
-^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~
 
 **Colour - Checker Detection** requires various dependencies in order to run:
 
-- `python>=3.5 <https://www.python.org/download/releases/>`__
+- `python >= 3.8, < 4 <https://www.python.org/download/releases/>`__
 - `colour-science <https://pypi.org/project/colour-science/>`__
-- `opencv-python>=4 <https://pypi.org/project/opencv-python/>`__
+- `opencv-python >= 4, < 5 <https://pypi.org/project/opencv-python/>`__
 
 Pypi
-^^^^
+~~~~
 
 Once the dependencies are satisfied, **Colour - Checker Detection** can be installed from
 the `Python Package Index <http://pypi.python.org/pypi/colour-checker-detection>`__ by
@@ -74,35 +83,26 @@ The overall development dependencies are installed as follows::
 
     pip install --user 'colour-checker-detection[development]'
 
-Usage
------
-
-API
-^^^
-
-The main reference for `Colour - Checker Detection <https://github.com/colour-science/colour-checker-detection>`__
-is the `Colour - Checker Detection Manual <https://colour-checker-detection.readthedocs.io/en/latest/manual.html>`__.
-
-Examples
-^^^^^^^^
-
-Various usage examples are available from the
-`examples directory <https://github.com/colour-science/colour-checker-detection/tree/master/colour_checker_detection/examples>`__.
-
 Contributing
-------------
+^^^^^^^^^^^^
 
 If you would like to contribute to `Colour - Checker Detection <https://github.com/colour-science/colour-checker-detection>`__,
 please refer to the following `Contributing <https://www.colour-science.org/contributing/>`__
 guide for `Colour <https://github.com/colour-science/colour>`__.
 
 Bibliography
-------------
+^^^^^^^^^^^^
 
 The bibliography is available in the repository in
 `BibTeX <https://github.com/colour-science/colour-checker-detection/blob/develop/BIBLIOGRAPHY.bib>`__
 format.
 
+API Reference
+-------------
+
+The main technical reference `Colour - Checker Detection <https://github.com/colour-science/colour-checker-detection>`__
+is the `API Reference <https://colour-checker-detection.readthedocs.io/en/latest/reference.html>`__.
+
 Code of Conduct
 ---------------
 
@@ -115,7 +115,6 @@ Contact & Social
 The *Colour Developers* can be reached via different means:
 
 - `Email <mailto:colour-developers@colour-science.org>`__
-- `Discourse <https://colour-science.discourse.group/>`__
 - `Facebook <https://www.facebook.com/python.colour.science>`__
 - `Github Discussions <https://github.com/colour-science/colour-checker-detection/discussions>`__
 - `Gitter <https://gitter.im/colour-science/colour>`__
@@ -125,6 +124,6 @@ About
 -----
 
 | **Colour - Checker Detection** by Colour Developers
-| Copyright © 2018-2021 – Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
+| Copyright 2018 Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
 | This software is released under terms of New BSD License: https://opensource.org/licenses/BSD-3-Clause
 | `https://github.com/colour-science/colour-checker-detection <https://github.com/colour-science/colour-checker-detection>`__

TODO.rst

@@ -18,6 +18,6 @@ About
 -----
 
 | **Colour - Checker Detection** by Colour Developers
-| Copyright © 2018-2021 – Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
+| Copyright 2018 Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
 | This software is released under terms of New BSD License: https://opensource.org/licenses/BSD-3-Clause
 | `https://github.com/colour-science/colour-checker-detection <https://github.com/colour-science/colour-checker-detection>`__

colour_checker_detection/__init__.py

@@ -27,7 +27,7 @@
 )
 
 __author__ = "Colour Developers"
-__copyright__ = "Copyright (C) 2018-2021 - Colour Developers"
+__copyright__ = "Copyright 2018 Colour Developers"
 __license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause"
 __maintainer__ = "Colour Developers"
 __email__ = "colour-developers@colour-science.org"

colour_checker_detection/detection/segmentation.py

@@ -53,7 +53,7 @@
 )
 
 __author__ = "Colour Developers"
-__copyright__ = "Copyright (C) 2018-2021 - Colour Developers"
+__copyright__ = "Copyright 2018 Colour Developers"
 __license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause"
 __maintainer__ = "Colour Developers"
 __email__ = "colour-developers@colour-science.org"
@@ -966,7 +966,7 @@ def detect_colour_checkers_segmentation(
     image: ArrayLike,
     samples: Integer = 16,
     additional_data: Boolean = False,
-    **kwargs: Any
+    **kwargs: Any,
 ) -> Union[Tuple[ColourCheckerSwatchesData, ...], Tuple[NDArray, ...]]:
     """
     Detect the colour checkers swatches in given image using segmentation.

colour_checker_detection/detection/tests/test_segmentation.py

@@ -31,7 +31,7 @@
 )
 
 __author__ = "Colour Developers"
-__copyright__ = "Copyright (C) 2018-2021 - Colour Developers"
+__copyright__ = "Copyright 2018 Colour Developers"
 __license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause"
 __maintainer__ = "Colour Developers"
 __email__ = "colour-developers@colour-science.org"