PR: Last Stretch for V2 (#110)

* Update dependencies. Signed-off-by: Thomas Mansencal <[email protected]> * Update "README.rst" file and documentation. Signed-off-by: Thomas Mansencal <[email protected]> * Raise package version to "2.0.0". Signed-off-by: Thomas Mansencal <[email protected]> --------- Signed-off-by: Thomas Mansencal <[email protected]>
AcademySoftwareFoundation · Sep 23, 2023 · 1abd145 · 1abd145
1 parent 10a851a
commit 1abd145
Show file tree

Hide file tree

Showing 9 changed files with 178 additions and 149 deletions.
diff --git a/README.rst b/README.rst
@@ -19,8 +19,8 @@ OpenColorIO Configuration for ACES
 
 .. end-badges
 
-The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/>`__
-is an open-source `Python <https://www.python.org/>`__ package implementing
+The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES>`__
+is an open-source `Python <https://www.python.org>`__ package implementing
 support for the generation of the *OCIO* configurations for the
 `Academy Color Encoding System <https://www.oscars.org/science-technology/sci-tech-projects/aces>`__
 (ACES).
@@ -77,17 +77,17 @@ The *OpenColorIO Configuration for ACES* repository adopts `Poetry <https://poet
 to help managing its dependencies, this is the recommended way to get started
 with development.
 
-Assuming `python >= 3.8 <https://www.python.org/download/releases/>`__ is
-available on your system along with `OpenColorIO <https://opencolorio.org/>`__,
+Assuming `python >= 3.9 <https://www.python.org/download/releases>`__ is
+available on your system along with `OpenColorIO <https://opencolorio.org>`__,
 the development dependencies are installed with `Poetry <https://poetry.eustace.io>`__
 as follows::
 
     git clone --recursive https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES.git
     cd OpenColorIO-Config-ACES
     poetry install --with optional
 
-The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <https://graphviz.org/>`__
-to be installed on the system and having installed the optional `pygraphviz <https://pypi.org/project/pygraphviz/>`__:
+The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <https://graphviz.org>`__
+to be installed on the system and having installed the optional `pygraphviz <https://pypi.org/project/pygraphviz>`__:
 python package::
 
     poetry install --with graphviz,optional
@@ -99,7 +99,7 @@ Installing the dependencies for the `previous config generator <https://github.c
 was not a trivial task. For ease of use an `aswf-docker <https://github.com/AcademySoftwareFoundation/aswf-docker>`__
 based container is now available.
 
-Creating the container from the `Dockerfile <https://docs.docker.com/engine/reference/builder/>`__
+Creating the container from the `Dockerfile <https://docs.docker.com/engine/reference/builder>`__
 is done as follows::
 
     docker build -t aswf/opencolorio-config-aces:latest .
@@ -122,38 +122,36 @@ dependencies in order to run and be able to generate the *OCIO* configurations:
 Primary Dependencies
 ********************
 
--   `python >= 3.9, < 3.11 <https://www.python.org/download/releases/>`__
--   `OpenColorIO <https://opencolorio.org/>`__
+-   `python >= 3.9, < 3.11 <https://www.python.org/download/releases>`__
+-   `opencolorio <https://pypi.org/project/opencolorio>`__
+-   `requests <https://pypi.org/project/requests>`__
+-   `semver <https://pypi.org/project/semver>`__
 
 Optional Dependencies
 *********************
 
--   `colour <https://www.colour-science.org/>`__
--   `graphviz <https://www.graphviz.org/>`__
--   `jsonpickle <https://jsonpickle.github.io/>`__
--   `networkx <https://pypi.org/project/networkx/>`__
--   `pygraphviz <https://pypi.org/project/pygraphviz/>`__
+-   `colour-science <https://pypi.org/project/colour-science>`__
+-   `graphviz <https://www.graphviz.org>`__
+-   `jsonpickle <https://jsonpickle.github.io>`__
+-   `networkx <https://pypi.org/project/networkx>`__
+-   `pygraphviz <https://pypi.org/project/pygraphviz>`__
 
 Development Dependencies
 ************************
 
--   `black <https://pypi.org/project/black/>`__
--   `coverage <https://pypi.org/project/coverage/>`__
--   `coveralls <https://pypi.org/project/coveralls/>`__
--   `invoke <https://pypi.org/project/invoke/>`__
--   `mypy <https://pypi.org/project/mypy/>`__
--   `pre-commit <https://pypi.org/project/pre-commit/>`__
--   `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme/>`__
--   `pytest <https://pypi.org/project/pytest/>`__
--   `restructuredtext-lint <https://pypi.org/project/restructuredtext-lint/>`__
--   `sphinx >= 4, < 5 <https://pypi.org/project/Sphinx/>`__
--   `twine <https://pypi.org/project/twine/>`__
-
-Once the dependencies are satisfied, the **OpenColorIO Configuration for ACES**
-package can be installed from the `Python Package Index <http://pypi.python.org/pypi/opencolorio-config-aces>`__
-by issuing this command in a shell::
-
-    pip install --user opencolorio-config-aces
+-   `black <https://pypi.org/project/black>`__
+-   `coverage <https://pypi.org/project/coverage>`__
+-   `coveralls <https://pypi.org/project/coveralls>`__
+-   `flynt <https://pypi.org/project/flynt>`__
+-   `invoke <https://pypi.org/project/invoke>`__
+-   `pre-commit <https://pypi.org/project/pre-commit>`__
+-   `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme>`__
+-   `pytest <https://pypi.org/project/pytest>`__
+-   `pytest-cov <https://pypi.org/project/pytest-cov>`__
+-   `restructuredtext-lint <https://pypi.org/project/restructuredtext-lint>`__
+-   `ruff <https://pypi.org/project/ruff>`__
+-   `sphinx >= 4, < 5 <https://pypi.org/project/sphinx>`__
+-   `twine <https://pypi.org/project/twine>`__
 
 Components Status
 ^^^^^^^^^^^^^^^^^
@@ -189,14 +187,16 @@ Components Status
 +-------------------------------+----------------+----------------------------------------------------------------------------------+
 | Containerisation              | Complete       | Minor updates will be required as the CLI evolves.                               |
 +-------------------------------+----------------+----------------------------------------------------------------------------------+
+| Pypi Package                  | Unavailable    |                                                                                  |
++-------------------------------+----------------+----------------------------------------------------------------------------------+
 
 Usage
 ^^^^^
 
 Tasks
 ~~~~~
 
-Various tasks are currently exposed via `invoke <https://pypi.org/project/invoke/>`__.
+Various tasks are currently exposed via `invoke <https://pypi.org/project/invoke>`__.
 
 This is currently the recommended way to build the configuration until a
 dedicated CLI is provided.
@@ -248,7 +248,7 @@ API Reference
 -------------
 
 The main technical reference for `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES>`__
-is the `API Reference <https://opencolorio-config-aces.readthedocs.io/>`__.
+is the `API Reference <https://opencolorio-config-aces.readthedocs.io>`__.
 
 About
 -----

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,8 +5,8 @@
 OpenColorIO Configuration for ACES
 ==================================
 
-The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/>`__
-is an open-source `Python <https://www.python.org/>`__ package implementing
+The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES>`__
+is an open-source `Python <https://www.python.org>`__ package implementing
 support for the generation of the *OCIO* configurations for the
 `Academy Color Encoding System <https://www.oscars.org/science-technology/sci-tech-projects/aces>`__
 (ACES).

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -25,17 +25,17 @@ The *OpenColorIO Configuration for ACES* repository adopts `Poetry <https://poet
 to help managing its dependencies, this is the recommended way to get started
 with development.
 
-Assuming `python >= 3.8 <https://www.python.org/download/releases/>`__ is
-available on your system along with `OpenColorIO >= 2 <https://opencolorio.org/>`__,
+Assuming `python >= 3.9 <https://www.python.org/download/releases>`__ is
+available on your system along with `OpenColorIO >= 2 <https://opencolorio.org>`__,
 the development dependencies are installed with `Poetry <https://poetry.eustace.io>`__
 as follows::
 
     git clone --recursive https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES.git
     cd OpenColorIO-Config-ACES
     poetry install --with optional
 
-The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <https://graphviz.org/>`__
-to be installed on the system and having installed the optional `pygraphviz <https://pypi.org/project/pygraphviz/>`__:
+The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <https://graphviz.org>`__
+to be installed on the system and having installed the optional `pygraphviz <https://pypi.org/project/pygraphviz>`__:
 python package::
 
     poetry install --with graphviz,optional
@@ -47,7 +47,7 @@ Installing the dependencies for the `previous config generator <https://github.c
 was not a trivial task. For ease of use an `aswf-docker <https://github.com/AcademySoftwareFoundation/aswf-docker>`__
 based container is now available.
 
-Creating the container from the `Dockerfile <https://docs.docker.com/engine/reference/builder/>`__
+Creating the container from the `Dockerfile <https://docs.docker.com/engine/reference/builder>`__
 is done as follows::
 
     docker build -t aswf/opencolorio-config-aces:latest .
@@ -70,36 +70,33 @@ dependencies in order to run and be able to generate the *OCIO* configurations:
 Primary Dependencies
 ********************
 
--   `python >= 3.9, < 3.11 <https://www.python.org/download/releases/>`__
--   `black <https://pypi.org/project/black/>`__
--   `OpenColorIO <https://opencolorio.org/>`__
+-   `python >= 3.9, < 3.11 <https://www.python.org/download/releases>`__
+-   `opencolorio <https://pypi.org/project/opencolorio>`__
+-   `requests <https://pypi.org/project/requests>`__
+-   `semver <https://pypi.org/project/semver>`__
 
 Optional Dependencies
 *********************
 
--   `colour <https://www.colour-science.org/>`__
--   `graphviz <https://www.graphviz.org/>`__
--   `jsonpickle <https://jsonpickle.github.io/>`__
--   `networkx <https://pypi.org/project/networkx/>`__
--   `pygraphviz <https://pypi.org/project/pygraphviz/>`__
+-   `colour-science <https://pypi.org/project/colour-science>`__
+-   `graphviz <https://www.graphviz.org>`__
+-   `jsonpickle <https://jsonpickle.github.io>`__
+-   `networkx <https://pypi.org/project/networkx>`__
+-   `pygraphviz <https://pypi.org/project/pygraphviz>`__
 
 Development Dependencies
 ************************
 
--   `black <https://pypi.org/project/black/>`__
--   `coverage <https://pypi.org/project/coverage/>`__
--   `coveralls <https://pypi.org/project/coveralls/>`__
--   `invoke <https://pypi.org/project/invoke/>`__
--   `mypy <https://pypi.org/project/mypy/>`__
--   `pre-commit <https://pypi.org/project/pre-commit/>`__
--   `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme/>`__
--   `pytest <https://pypi.org/project/pytest/>`__
--   `restructuredtext-lint <https://pypi.org/project/restructuredtext-lint/>`__
--   `sphinx >= 4, < 5 <https://pypi.org/project/Sphinx/>`__
--   `twine <https://pypi.org/project/twine/>`__
-
-Once the dependencies are satisfied, the **OpenColorIO Configuration for ACES**
-package can be installed from the `Python Package Index <http://pypi.python.org/pypi/opencolorio-config-aces>`__
-by issuing this command in a shell::
-
-    pip install --user opencolorio-config-aces
+-   `black <https://pypi.org/project/black>`__
+-   `coverage <https://pypi.org/project/coverage>`__
+-   `coveralls <https://pypi.org/project/coveralls>`__
+-   `flynt <https://pypi.org/project/flynt>`__
+-   `invoke <https://pypi.org/project/invoke>`__
+-   `pre-commit <https://pypi.org/project/pre-commit>`__
+-   `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme>`__
+-   `pytest <https://pypi.org/project/pytest>`__
+-   `pytest-cov <https://pypi.org/project/pytest-cov>`__
+-   `restructuredtext-lint <https://pypi.org/project/restructuredtext-lint>`__
+-   `ruff <https://pypi.org/project/ruff>`__
+-   `sphinx >= 4, < 5 <https://pypi.org/project/sphinx>`__
+-   `twine <https://pypi.org/project/twine>`__
diff --git a/docs/process.rst b/docs/process.rst
@@ -25,6 +25,8 @@ Using ``ACES2065-1`` and ``OCES`` as connection spaces, it is possible to build
 
     .. image:: _static/ACES_Conversion_Graph.svg
 
+An initial mapping of *ACES* **AMF** components is generated after the classification process. The mapping defines the ``ACEStransformID`` relationships. Its generation is automated but needs to be guided by an external file, i.e. `opencolorio_config_aces/config/reference/discover/resources/ACES_AMF_Components.json`, because a few relationships cannot be derived automatically.
+
 Analytical & Reference Configs Generation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,31 @@
+accessible-pygments==0.0.4 ; python_version >= "3.9" and python_version < "3.12"
+alabaster==0.7.13 ; python_version >= "3.9" and python_version < "3.12"
+babel==2.12.1 ; python_version >= "3.9" and python_version < "3.12"
+beautifulsoup4==4.12.2 ; python_version >= "3.9" and python_version < "3.12"
+certifi==2023.5.7 ; python_version >= "3.9" and python_version < "3.12"
+charset-normalizer==3.1.0 ; python_version >= "3.9" and python_version < "3.12"
+colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.12" and sys_platform == "win32"
+docutils==0.17.1 ; python_version >= "3.9" and python_version < "3.12"
+idna==3.4 ; python_version >= "3.9" and python_version < "3.12"
+imagesize==1.4.1 ; python_version >= "3.9" and python_version < "3.12"
+importlib-metadata==6.6.0 ; python_version >= "3.9" and python_version < "3.10"
+jinja2==3.1.2 ; python_version >= "3.9" and python_version < "3.12"
+markupsafe==2.1.3 ; python_version >= "3.9" and python_version < "3.12"
+opencolorio==2.3.0 ; python_version >= "3.9" and python_version < "3.12"
+packaging==23.1 ; python_version >= "3.9" and python_version < "3.12"
+pydata-sphinx-theme==0.13.3 ; python_version >= "3.9" and python_version < "3.12"
+pygments==2.15.1 ; python_version >= "3.9" and python_version < "3.12"
+requests==2.31.0 ; python_version >= "3.9" and python_version < "3.12"
+semver==3.0.1 ; python_version >= "3.9" and python_version < "3.12"
+snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "3.12"
+soupsieve==2.4.1 ; python_version >= "3.9" and python_version < "3.12"
+sphinx==4.5.0 ; python_version >= "3.9" and python_version < "3.12"
+sphinxcontrib-applehelp==1.0.4 ; python_version >= "3.9" and python_version < "3.12"
+sphinxcontrib-devhelp==1.0.2 ; python_version >= "3.9" and python_version < "3.12"
+sphinxcontrib-htmlhelp==2.0.1 ; python_version >= "3.9" and python_version < "3.12"
+sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" and python_version < "3.12"
+sphinxcontrib-qthelp==1.0.3 ; python_version >= "3.9" and python_version < "3.12"
+sphinxcontrib-serializinghtml==1.1.5 ; python_version >= "3.9" and python_version < "3.12"
+typing-extensions==4.6.3 ; python_version >= "3.9" and python_version < "3.12"
+urllib3==2.0.3 ; python_version >= "3.9" and python_version < "3.12"
+zipp==3.15.0 ; python_version >= "3.9" and python_version < "3.10"
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -8,7 +8,7 @@ Usage
 Tasks
 ^^^^^
 
-Various tasks are currently exposed via `invoke <https://pypi.org/project/invoke/>`__.
+Various tasks are currently exposed via `invoke <https://pypi.org/project/invoke>`__.
 
 This is currently the recommended way to build the configuration until a
 dedicated CLI is provided.

diff --git a/opencolorio_config_aces/__init__.py b/opencolorio_config_aces/__init__.py
@@ -126,7 +126,7 @@
 
 __application_name__ = "OpenColorIO Configuration for ACES"
 
-__major_version__ = "1"
+__major_version__ = "2"
 __minor_version__ = "0"
 __change_version__ = "0"
 __version__ = ".".join(

diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@
 
 [tool.poetry]
 name = "opencolorio-config-aces"
-version = "1.0.0"
+version = "2.0.0"
 description = "OpenColorIO Configuration for ACES"
 authors = [ "OpenColorIO Contributors" ]
 maintainers = [ "OpenColorIO Contributors <[email protected]>" ]
@@ -37,7 +37,6 @@ coverage = "*"
 coveralls = "*"
 flynt = "*"
 invoke = "*"
-mypy = "*"
 pre-commit = "*"
 pydata-sphinx-theme = "*"
 pytest = "*"