Merge branch 'feature/v0.1.2' into develop

Author: KelSolaar

.github/workflows/continuous-integration.yml

@@ -31,7 +31,7 @@ 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 --preview --version 1.0.0b3
+        python get-poetry.py
         PATH=$HOME/.poetry/bin:$PATH
         echo ::set-env name=PATH::$PATH
     - name: Install Package Dependencies
@@ -81,7 +81,7 @@ 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 --preview --version 1.0.0b3
+        python get-poetry.py
         set PATH=%USERPROFILE%\.poetry\bin;%PATH%
         echo ::set-env name=PATH::%PATH%
       shell: cmd

.pre-commit-config.yaml

@@ -3,8 +3,9 @@ repos:
     rev: 3.7.8
     hooks:
     -   id: flake8
-        exclude: examples
+        exclude: examples|setup\.py
 -   repo: https://github.com/pre-commit/mirrors-yapf
     rev: v0.23.0
     hooks:
     -   id: yapf
+        exclude: setup\.py

.readthedocs.yml

@@ -2,7 +2,7 @@ build:
     image: latest
 
 python:
-    version: 3.6
+    version: 3.7
     pip_install: true
     extra_requirements:
         - read-the-docs

README.rst

@@ -57,9 +57,9 @@ Primary Dependencies
 
 **Colour - Checker Detection** requires various dependencies in order to run:
 
--  `Python >=3.5 <https://www.python.org/download/releases/>`__
--  `Colour Science <https://www.colour-science.org>`__
--  `opencv-python >=4 <https://pypi.org/project/opencv-python/>`__
+-   `python>=3.5 <https://www.python.org/download/releases/>`__
+-   `colour-science <https://pypi.org/project/colour-science/>`__
+-   `opencv-python>=4 <https://pypi.org/project/opencv-python/>`__
 
 Pypi
 ^^^^
@@ -68,11 +68,11 @@ Once the dependencies satisfied, **Colour - Checker Detection** can be installed
 the `Python Package Index <http://pypi.python.org/pypi/colour-checker-detection>`__ by
 issuing this command in a shell::
 
-	pip install colour-checker-detection
+	pip install --user colour-checker-detection
 
 The overall development dependencies are installed as follows::
 
-    pip install 'colour-checker-detection[development]'
+    pip install --user 'colour-checker-detection[development]'
 
 Usage
 -----

colour_checker_detection/examples/examples_detection.ipynb

@@ -379,15 +379,15 @@
     "    \n",
     "    image_a = adjust_image(image)\n",
     "\n",
-    "    plot_image(colour.cctf_encoding(segmented_image), text_parameters={\n",
+    "    plot_image(colour.cctf_encoding(segmented_image), text_kwargs={\n",
     "        'text': 'Segmented Image',\n",
     "        'color': 'black'\n",
     "    })\n",
     "    \n",
     "    cv2.drawContours(image_a, swatches, -1, (1, 0, 1), 3)\n",
     "    cv2.drawContours(image_a, clusters, -1, (0, 1, 1), 3)\n",
     "\n",
-    "    plot_image(colour.cctf_encoding(image_a), text_parameters={\n",
+    "    plot_image(colour.cctf_encoding(image_a), text_kwargs={\n",
     "        'text': 'Swatches & Clusters',\n",
     "        'color': 'white'\n",
     "    });"

docs/_static/custom.css

@@ -20,7 +20,7 @@ p {
 
 div.highlight-text {
     background-color: rgb(252, 252, 252) !important;
-    border: 0 !important;
     font-family: monospace;
+    font-style: italic;
     margin: -24px 0 24px 0;
 }

docs/conf.py

@@ -19,9 +19,12 @@
 basename = re.sub('_(\\w)', lambda x: x.group(1).upper(),
                   package.__name__.title())
 
+autodoc_member_order = 'bysource'
+autodoc_mock_imports = ['colour', 'cv2']
+
 autosummary_generate = True
 
-autodoc_mock_imports = ['colour', 'cv2']
+napoleon_custom_sections = ['Attributes', 'Methods']
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -37,9 +40,9 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
-    'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode',
-    'sphinx.ext.autosummary', 'sphinx.ext.napoleon', 'sphinx.ext.mathjax',
+    'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax',
+    'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx.ext.viewcode',
     'sphinxcontrib.bibtex'
 ]
 

docs/index.rst

@@ -37,10 +37,9 @@ Primary Dependencies
 
 **Colour - Checker Detection** requires various dependencies in order to run:
 
--  `Python 2.7 <https://www.python.org/download/releases/>`__ or
-   `Python 3.7 <https://www.python.org/download/releases/>`__
--  `Colour Science <https://www.colour-science.org>`__
--  `opencv-python <https://pypi.org/project/opencv-python/>`__
+-   `python>=3.5 <https://www.python.org/download/releases/>`__
+-   `colour-science <https://pypi.org/project/colour-science/>`__
+-   `opencv-python>=4 <https://pypi.org/project/opencv-python/>`__
 
 Pypi
 ^^^^
@@ -49,19 +48,19 @@ Once the dependencies satisfied, **Colour - Checker Detection** can be installed
 the `Python Package Index <http://pypi.python.org/pypi/colour-checker-detection>`__ by
 issuing this command in a shell::
 
-	pip install colour-checker-detection
+	pip install --user colour-checker-detection
 
 The tests suite dependencies are installed as follows::
 
-    pip install 'colour-checker-detection[tests]'
+    pip install --user 'colour-checker-detection[tests]'
 
 The documentation building dependencies are installed as follows::
 
-    pip install 'colour-checker-detection[docs]'
+    pip install --user 'colour-checker-detection[docs]'
 
 The overall development dependencies are installed as follows::
 
-    pip install 'colour-checker-detection[development]'
+    pip install --user 'colour-checker-detection[development]'
 
 Usage
 -----

setup.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+import codecs
+from setuptools import setup
+
+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/*']}
+
+install_requires = \
+['colour-science>=0.3.14,<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',
+                 '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.1',
+    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.5,<4.0',
+)

tasks.py

@@ -255,7 +255,7 @@ def docs(ctx, html=True, pdf=True):
         Task success.
     """
 
-    with ctx.prefix('export COLOUR_SCIENCE_DOCUMENTATION_BUILD=True'):
+    with ctx.prefix('export COLOUR_SCIENCE__DOCUMENTATION_BUILD=True'):
         with ctx.cd('docs'):
             if html:
                 message_box('Building "HTML" documentation...')
@@ -329,6 +329,51 @@ def build(ctx):
 
     message_box('Building...')
     ctx.run('poetry build')
+
+    with ctx.cd('dist'):
+        ctx.run('tar -xvf {0}-{1}.tar.gz'.format(PYPI_PACKAGE_NAME,
+                                                 APPLICATION_VERSION))
+        ctx.run('cp {0}-{1}/setup.py ../'.format(PYPI_PACKAGE_NAME,
+                                                 APPLICATION_VERSION))
+
+        ctx.run('rm -rf {0}-{1}'.format(PYPI_PACKAGE_NAME,
+                                        APPLICATION_VERSION))
+
+    with open('setup.py') as setup_file:
+        source = setup_file.read()
+
+    setup_kwargs = []
+
+    def sub_callable(match):
+        setup_kwargs.append(match)
+
+        return ''
+
+    template = """
+setup({0}
+)
+"""
+
+    source = re.sub('from setuptools import setup',
+                    'import codecs\nfrom setuptools import setup', source)
+    source = re.sub(
+        'setup_kwargs = {(.*)}.*setup\\(\\*\\*setup_kwargs\\)',
+        sub_callable,
+        source,
+        flags=re.DOTALL)[:-2]
+    setup_kwargs = setup_kwargs[0].group(1).splitlines()
+    for i, line in enumerate(setup_kwargs):
+        setup_kwargs[i] = re.sub('^\\s*(\'(\\w+)\':\\s?)', '    \\2=', line)
+        if setup_kwargs[i].strip().startswith('long_description'):
+            setup_kwargs[i] = ('    long_description='
+                               'codecs.open(\'README.rst\', encoding=\'utf8\')'
+                               '.read(),')
+
+    source += template.format('\n'.join(setup_kwargs))
+
+    with open('setup.py', 'w') as setup_file:
+        setup_file.write(source)
+
     ctx.run('twine check dist/*')