Skip to content

Commit 1abd145

Browse files
KelSolaarKelSolaar
authored
PR: Last Stretch for V2 (#110)
* Update dependencies. Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com> * Update "README.rst" file and documentation. Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com> * Raise package version to "2.0.0". Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com> --------- Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com>
1 parent 10a851a commit 1abd145

File tree

9 files changed

+178
-149
lines changed

9 files changed

+178
-149
lines changed

‎README.rst

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ OpenColorIO Configuration for ACES
1919

2020
.. end-badges
2121
22-
The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/>`__
23-
is an open-source `Python <https://www.python.org/>`__ package implementing
22+
The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES>`__
23+
is an open-source `Python <https://www.python.org>`__ package implementing
2424
support for the generation of the *OCIO* configurations for the
2525
`Academy Color Encoding System <https://www.oscars.org/science-technology/sci-tech-projects/aces>`__
2626
(ACES).
@@ -77,17 +77,17 @@ The *OpenColorIO Configuration for ACES* repository adopts `Poetry <https://poet
7777
to help managing its dependencies, this is the recommended way to get started
7878
with development.
7979

80-
Assuming `python >= 3.8 <https://www.python.org/download/releases/>`__ is
81-
available on your system along with `OpenColorIO <https://opencolorio.org/>`__,
80+
Assuming `python >= 3.9 <https://www.python.org/download/releases>`__ is
81+
available on your system along with `OpenColorIO <https://opencolorio.org>`__,
8282
the development dependencies are installed with `Poetry <https://poetry.eustace.io>`__
8383
as follows::
8484

8585
git clone --recursive https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES.git
8686
cd OpenColorIO-Config-ACES
8787
poetry install --with optional
8888

89-
The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <https://graphviz.org/>`__
90-
to be installed on the system and having installed the optional `pygraphviz <https://pypi.org/project/pygraphviz/>`__:
89+
The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <https://graphviz.org>`__
90+
to be installed on the system and having installed the optional `pygraphviz <https://pypi.org/project/pygraphviz>`__:
9191
python package::
9292

9393
poetry install --with graphviz,optional
@@ -99,7 +99,7 @@ Installing the dependencies for the `previous config generator <https://github.c
9999
was not a trivial task. For ease of use an `aswf-docker <https://github.com/AcademySoftwareFoundation/aswf-docker>`__
100100
based container is now available.
101101

102-
Creating the container from the `Dockerfile <https://docs.docker.com/engine/reference/builder/>`__
102+
Creating the container from the `Dockerfile <https://docs.docker.com/engine/reference/builder>`__
103103
is done as follows::
104104

105105
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:
122122
Primary Dependencies
123123
********************
124124

125-
- `python >= 3.9, < 3.11 <https://www.python.org/download/releases/>`__
126-
- `OpenColorIO <https://opencolorio.org/>`__
125+
- `python >= 3.9, < 3.11 <https://www.python.org/download/releases>`__
126+
- `opencolorio <https://pypi.org/project/opencolorio>`__
127+
- `requests <https://pypi.org/project/requests>`__
128+
- `semver <https://pypi.org/project/semver>`__
127129

128130
Optional Dependencies
129131
*********************
130132

131-
- `colour <https://www.colour-science.org/>`__
132-
- `graphviz <https://www.graphviz.org/>`__
133-
- `jsonpickle <https://jsonpickle.github.io/>`__
134-
- `networkx <https://pypi.org/project/networkx/>`__
135-
- `pygraphviz <https://pypi.org/project/pygraphviz/>`__
133+
- `colour-science <https://pypi.org/project/colour-science>`__
134+
- `graphviz <https://www.graphviz.org>`__
135+
- `jsonpickle <https://jsonpickle.github.io>`__
136+
- `networkx <https://pypi.org/project/networkx>`__
137+
- `pygraphviz <https://pypi.org/project/pygraphviz>`__
136138

137139
Development Dependencies
138140
************************
139141

140-
- `black <https://pypi.org/project/black/>`__
141-
- `coverage <https://pypi.org/project/coverage/>`__
142-
- `coveralls <https://pypi.org/project/coveralls/>`__
143-
- `invoke <https://pypi.org/project/invoke/>`__
144-
- `mypy <https://pypi.org/project/mypy/>`__
145-
- `pre-commit <https://pypi.org/project/pre-commit/>`__
146-
- `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme/>`__
147-
- `pytest <https://pypi.org/project/pytest/>`__
148-
- `restructuredtext-lint <https://pypi.org/project/restructuredtext-lint/>`__
149-
- `sphinx >= 4, < 5 <https://pypi.org/project/Sphinx/>`__
150-
- `twine <https://pypi.org/project/twine/>`__
151-
152-
Once the dependencies are satisfied, the **OpenColorIO Configuration for ACES**
153-
package can be installed from the `Python Package Index <http://pypi.python.org/pypi/opencolorio-config-aces>`__
154-
by issuing this command in a shell::
155-
156-
pip install --user opencolorio-config-aces
142+
- `black <https://pypi.org/project/black>`__
143+
- `coverage <https://pypi.org/project/coverage>`__
144+
- `coveralls <https://pypi.org/project/coveralls>`__
145+
- `flynt <https://pypi.org/project/flynt>`__
146+
- `invoke <https://pypi.org/project/invoke>`__
147+
- `pre-commit <https://pypi.org/project/pre-commit>`__
148+
- `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme>`__
149+
- `pytest <https://pypi.org/project/pytest>`__
150+
- `pytest-cov <https://pypi.org/project/pytest-cov>`__
151+
- `restructuredtext-lint <https://pypi.org/project/restructuredtext-lint>`__
152+
- `ruff <https://pypi.org/project/ruff>`__
153+
- `sphinx >= 4, < 5 <https://pypi.org/project/sphinx>`__
154+
- `twine <https://pypi.org/project/twine>`__
157155

158156
Components Status
159157
^^^^^^^^^^^^^^^^^
@@ -189,14 +187,16 @@ Components Status
189187
+-------------------------------+----------------+----------------------------------------------------------------------------------+
190188
| Containerisation | Complete | Minor updates will be required as the CLI evolves. |
191189
+-------------------------------+----------------+----------------------------------------------------------------------------------+
190+
| Pypi Package | Unavailable | |
191+
+-------------------------------+----------------+----------------------------------------------------------------------------------+
192192

193193
Usage
194194
^^^^^
195195

196196
Tasks
197197
~~~~~
198198

199-
Various tasks are currently exposed via `invoke <https://pypi.org/project/invoke/>`__.
199+
Various tasks are currently exposed via `invoke <https://pypi.org/project/invoke>`__.
200200

201201
This is currently the recommended way to build the configuration until a
202202
dedicated CLI is provided.
@@ -248,7 +248,7 @@ API Reference
248248
-------------
249249

250250
The main technical reference for `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES>`__
251-
is the `API Reference <https://opencolorio-config-aces.readthedocs.io/>`__.
251+
is the `API Reference <https://opencolorio-config-aces.readthedocs.io>`__.
252252

253253
About
254254
-----

‎docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
OpenColorIO Configuration for ACES
66
==================================
77

8-
The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/>`__
9-
is an open-source `Python <https://www.python.org/>`__ package implementing
8+
The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES>`__
9+
is an open-source `Python <https://www.python.org>`__ package implementing
1010
support for the generation of the *OCIO* configurations for the
1111
`Academy Color Encoding System <https://www.oscars.org/science-technology/sci-tech-projects/aces>`__
1212
(ACES).

‎docs/installation.rst

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ The *OpenColorIO Configuration for ACES* repository adopts `Poetry <https://poet
2525
to help managing its dependencies, this is the recommended way to get started
2626
with development.
2727

28-
Assuming `python >= 3.8 <https://www.python.org/download/releases/>`__ is
29-
available on your system along with `OpenColorIO >= 2 <https://opencolorio.org/>`__,
28+
Assuming `python >= 3.9 <https://www.python.org/download/releases>`__ is
29+
available on your system along with `OpenColorIO >= 2 <https://opencolorio.org>`__,
3030
the development dependencies are installed with `Poetry <https://poetry.eustace.io>`__
3131
as follows::
3232

3333
git clone --recursive https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES.git
3434
cd OpenColorIO-Config-ACES
3535
poetry install --with optional
3636

37-
The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <https://graphviz.org/>`__
38-
to be installed on the system and having installed the optional `pygraphviz <https://pypi.org/project/pygraphviz/>`__:
37+
The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <https://graphviz.org>`__
38+
to be installed on the system and having installed the optional `pygraphviz <https://pypi.org/project/pygraphviz>`__:
3939
python package::
4040

4141
poetry install --with graphviz,optional
@@ -47,7 +47,7 @@ Installing the dependencies for the `previous config generator <https://github.c
4747
was not a trivial task. For ease of use an `aswf-docker <https://github.com/AcademySoftwareFoundation/aswf-docker>`__
4848
based container is now available.
4949

50-
Creating the container from the `Dockerfile <https://docs.docker.com/engine/reference/builder/>`__
50+
Creating the container from the `Dockerfile <https://docs.docker.com/engine/reference/builder>`__
5151
is done as follows::
5252

5353
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:
7070
Primary Dependencies
7171
********************
7272

73-
- `python >= 3.9, < 3.11 <https://www.python.org/download/releases/>`__
74-
- `black <https://pypi.org/project/black/>`__
75-
- `OpenColorIO <https://opencolorio.org/>`__
73+
- `python >= 3.9, < 3.11 <https://www.python.org/download/releases>`__
74+
- `opencolorio <https://pypi.org/project/opencolorio>`__
75+
- `requests <https://pypi.org/project/requests>`__
76+
- `semver <https://pypi.org/project/semver>`__
7677

7778
Optional Dependencies
7879
*********************
7980

80-
- `colour <https://www.colour-science.org/>`__
81-
- `graphviz <https://www.graphviz.org/>`__
82-
- `jsonpickle <https://jsonpickle.github.io/>`__
83-
- `networkx <https://pypi.org/project/networkx/>`__
84-
- `pygraphviz <https://pypi.org/project/pygraphviz/>`__
81+
- `colour-science <https://pypi.org/project/colour-science>`__
82+
- `graphviz <https://www.graphviz.org>`__
83+
- `jsonpickle <https://jsonpickle.github.io>`__
84+
- `networkx <https://pypi.org/project/networkx>`__
85+
- `pygraphviz <https://pypi.org/project/pygraphviz>`__
8586

8687
Development Dependencies
8788
************************
8889

89-
- `black <https://pypi.org/project/black/>`__
90-
- `coverage <https://pypi.org/project/coverage/>`__
91-
- `coveralls <https://pypi.org/project/coveralls/>`__
92-
- `invoke <https://pypi.org/project/invoke/>`__
93-
- `mypy <https://pypi.org/project/mypy/>`__
94-
- `pre-commit <https://pypi.org/project/pre-commit/>`__
95-
- `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme/>`__
96-
- `pytest <https://pypi.org/project/pytest/>`__
97-
- `restructuredtext-lint <https://pypi.org/project/restructuredtext-lint/>`__
98-
- `sphinx >= 4, < 5 <https://pypi.org/project/Sphinx/>`__
99-
- `twine <https://pypi.org/project/twine/>`__
100-
101-
Once the dependencies are satisfied, the **OpenColorIO Configuration for ACES**
102-
package can be installed from the `Python Package Index <http://pypi.python.org/pypi/opencolorio-config-aces>`__
103-
by issuing this command in a shell::
104-
105-
pip install --user opencolorio-config-aces
90+
- `black <https://pypi.org/project/black>`__
91+
- `coverage <https://pypi.org/project/coverage>`__
92+
- `coveralls <https://pypi.org/project/coveralls>`__
93+
- `flynt <https://pypi.org/project/flynt>`__
94+
- `invoke <https://pypi.org/project/invoke>`__
95+
- `pre-commit <https://pypi.org/project/pre-commit>`__
96+
- `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme>`__
97+
- `pytest <https://pypi.org/project/pytest>`__
98+
- `pytest-cov <https://pypi.org/project/pytest-cov>`__
99+
- `restructuredtext-lint <https://pypi.org/project/restructuredtext-lint>`__
100+
- `ruff <https://pypi.org/project/ruff>`__
101+
- `sphinx >= 4, < 5 <https://pypi.org/project/sphinx>`__
102+
- `twine <https://pypi.org/project/twine>`__

‎docs/process.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Using ``ACES2065-1`` and ``OCES`` as connection spaces, it is possible to build
2525

2626
.. image:: _static/ACES_Conversion_Graph.svg
2727

28+
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.
29+
2830
Analytical & Reference Configs Generation
2931
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3032

‎docs/requirements.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
accessible-pygments==0.0.4 ; python_version >= "3.9" and python_version < "3.12"
2+
alabaster==0.7.13 ; python_version >= "3.9" and python_version < "3.12"
3+
babel==2.12.1 ; python_version >= "3.9" and python_version < "3.12"
4+
beautifulsoup4==4.12.2 ; python_version >= "3.9" and python_version < "3.12"
5+
certifi==2023.5.7 ; python_version >= "3.9" and python_version < "3.12"
6+
charset-normalizer==3.1.0 ; python_version >= "3.9" and python_version < "3.12"
7+
colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.12" and sys_platform == "win32"
8+
docutils==0.17.1 ; python_version >= "3.9" and python_version < "3.12"
9+
idna==3.4 ; python_version >= "3.9" and python_version < "3.12"
10+
imagesize==1.4.1 ; python_version >= "3.9" and python_version < "3.12"
11+
importlib-metadata==6.6.0 ; python_version >= "3.9" and python_version < "3.10"
12+
jinja2==3.1.2 ; python_version >= "3.9" and python_version < "3.12"
13+
markupsafe==2.1.3 ; python_version >= "3.9" and python_version < "3.12"
14+
opencolorio==2.3.0 ; python_version >= "3.9" and python_version < "3.12"
15+
packaging==23.1 ; python_version >= "3.9" and python_version < "3.12"
16+
pydata-sphinx-theme==0.13.3 ; python_version >= "3.9" and python_version < "3.12"
17+
pygments==2.15.1 ; python_version >= "3.9" and python_version < "3.12"
18+
requests==2.31.0 ; python_version >= "3.9" and python_version < "3.12"
19+
semver==3.0.1 ; python_version >= "3.9" and python_version < "3.12"
20+
snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "3.12"
21+
soupsieve==2.4.1 ; python_version >= "3.9" and python_version < "3.12"
22+
sphinx==4.5.0 ; python_version >= "3.9" and python_version < "3.12"
23+
sphinxcontrib-applehelp==1.0.4 ; python_version >= "3.9" and python_version < "3.12"
24+
sphinxcontrib-devhelp==1.0.2 ; python_version >= "3.9" and python_version < "3.12"
25+
sphinxcontrib-htmlhelp==2.0.1 ; python_version >= "3.9" and python_version < "3.12"
26+
sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" and python_version < "3.12"
27+
sphinxcontrib-qthelp==1.0.3 ; python_version >= "3.9" and python_version < "3.12"
28+
sphinxcontrib-serializinghtml==1.1.5 ; python_version >= "3.9" and python_version < "3.12"
29+
typing-extensions==4.6.3 ; python_version >= "3.9" and python_version < "3.12"
30+
urllib3==2.0.3 ; python_version >= "3.9" and python_version < "3.12"
31+
zipp==3.15.0 ; python_version >= "3.9" and python_version < "3.10"

‎docs/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Usage
88
Tasks
99
^^^^^
1010

11-
Various tasks are currently exposed via `invoke <https://pypi.org/project/invoke/>`__.
11+
Various tasks are currently exposed via `invoke <https://pypi.org/project/invoke>`__.
1212

1313
This is currently the recommended way to build the configuration until a
1414
dedicated CLI is provided.

‎opencolorio_config_aces/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126

127127
__application_name__ = "OpenColorIO Configuration for ACES"
128128

129-
__major_version__ = "1"
129+
__major_version__ = "2"
130130
__minor_version__ = "0"
131131
__change_version__ = "0"
132132
__version__ = ".".join(

‎pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[tool.poetry]
55
name = "opencolorio-config-aces"
6-
version = "1.0.0"
6+
version = "2.0.0"
77
description = "OpenColorIO Configuration for ACES"
88
authors = [ "OpenColorIO Contributors" ]
99
maintainers = [ "OpenColorIO Contributors <ocio-dev@lists.aswf.io>" ]
@@ -37,7 +37,6 @@ coverage = "*"
3737
coveralls = "*"
3838
flynt = "*"
3939
invoke = "*"
40-
mypy = "*"
4140
pre-commit = "*"
4241
pydata-sphinx-theme = "*"
4342
pytest = "*"

0 commit comments

Comments
 (0)