Update "Reference Config" description.

Signed-off-by: Thomas Mansencal <[email protected]>

Author: KelSolaar

docs/opencolorio_config_aces.utilities.rst

@@ -29,3 +29,4 @@ Common
     required
     is_string
     is_iterable
+    git_describe

opencolorio_config_aces/config/reference/generate/config.py

@@ -14,6 +14,7 @@
 import logging
 import re
 from collections import defaultdict
+from datetime import datetime
 from enum import Flag, auto
 from pathlib import Path
 
@@ -23,7 +24,7 @@
 from opencolorio_config_aces.config.reference import (
     classify_aces_ctl_transforms, discover_aces_ctl_transforms,
     unclassify_ctl_transforms)
-from opencolorio_config_aces.utilities import required
+from opencolorio_config_aces.utilities import git_describe, required
 
 __author__ = 'OpenColorIO Contributors'
 __copyright__ = 'Copyright Contributors to the OpenColorIO Project.'
@@ -1066,7 +1067,16 @@ def generate_config_aces(
         })
 
     data = ConfigData(
-        description='The "Academy Color Encoding System" reference config.',
+        description=(
+            f'The "Academy Color Encoding System" (ACES) "Reference Config".'
+            f'\n\n'
+            f'This "OpenColorIO" config is a strict and quasi-analytical '
+            f'implementation of "aces-dev" and is designed as a reference for '
+            f'software developers. It is not a replacement for the previous '
+            f'"ACES" configs nor the "ACES Studio Config".'
+            f'\n\n'
+            f'Generated with "OpenColorIO-Config-ACES" {git_describe()} '
+            f'on the {datetime.now().strftime("%Y/%m/%d at %H:%M")}.'),
         roles={
             ocio.ROLE_COLOR_TIMING: f'{aces_family_prefix} - ACEScct',
             ocio.ROLE_COMPOSITING_LOG: f'{aces_family_prefix} - ACEScct',

opencolorio_config_aces/utilities/__init__.py

@@ -4,11 +4,11 @@
 from .common import (
     DocstringDict, first_item, common_ancestor, paths_common_ancestor,
     vivification, vivified_to_dict, message_box, is_opencolorio_installed,
-    REQUIREMENTS_TO_CALLABLE, required, is_string, is_iterable)
+    REQUIREMENTS_TO_CALLABLE, required, is_string, is_iterable, git_describe)
 
 __all__ = [
     'DocstringDict', 'first_item', 'common_ancestor', 'paths_common_ancestor',
     'vivification', 'vivified_to_dict', 'message_box',
     'is_opencolorio_installed', 'REQUIREMENTS_TO_CALLABLE', 'required',
-    'is_string', 'is_iterable'
+    'is_string', 'is_iterable', 'git_describe'
 ]

opencolorio_config_aces/utilities/common.py

@@ -9,6 +9,7 @@
 
 import functools
 import os
+import subprocess
 from collections import defaultdict
 from itertools import chain
 from textwrap import TextWrapper
@@ -24,7 +25,7 @@
     'DocstringDict', 'first_item', 'common_ancestor', 'paths_common_ancestor',
     'vivification', 'vivified_to_dict', 'message_box', 'is_networkx_installed',
     'is_opencolorio_installed', 'REQUIREMENTS_TO_CALLABLE', 'required',
-    'is_string', 'is_iterable'
+    'is_string', 'is_iterable', 'git_describe'
 ]
 
 
@@ -412,3 +413,27 @@ def is_iterable(a):
     """
 
     return is_string(a) or (True if getattr(a, '__iter__', False) else False)
+
+
+def git_describe():
+    """
+    Describes the current *OpenColorIO Configuration for ACES* *git* version.
+
+    Returns
+    -------
+    >>> git_describe()  # doctest: +SKIP
+    '0.1.0'
+    """
+
+    import opencolorio_config_aces
+
+    try:  # pragma: no cover
+        version = subprocess.check_output(
+            ['git', 'describe'],
+            cwd=opencolorio_config_aces.__path__[0],
+            stderr=subprocess.STDOUT).strip()
+        version = version.decode('utf-8')
+    except Exception:  # pragma: no cover
+        version = opencolorio_config_aces.__version__
+
+    return version