📝 Document Python and package versions

CPAC/pipeline/cpac_pipeline.py

@@ -207,7 +207,7 @@
 from CPAC.pipeline.schema import valid_options
 from CPAC.utils.trimmer import the_trimmer
 from CPAC.utils import Configuration, set_subject
-
+from CPAC.utils.docs import version_report
 from CPAC.qc.pipeline import create_qc_workflow
 from CPAC.qc.xcp import qc_xcp
 
@@ -362,6 +362,8 @@ def run_workflow(sub_dict, c, run, pipeline_timing_info=None, p_name=None,
 
     C-PAC version: {cpac_version}
 
+    {dependency_versions}
+
     {license_notice}
 
     Setting maximum number of cores per participant to {cores}
@@ -391,6 +393,7 @@ def run_workflow(sub_dict, c, run, pipeline_timing_info=None, p_name=None,
     logger.info('%s', information.format(
         run_command=' '.join(['run', *sys.argv[1:]]),
         cpac_version=CPAC.__version__,
+        dependency_versions=version_report(),
         cores=c.pipeline_setup['system_config']['max_cores_per_participant'],
         participants=c.pipeline_setup['system_config'][
             'num_participants_at_once'],

CPAC/utils/docs.py

@@ -3,6 +3,7 @@
 from urllib import request
 from urllib.error import ContentTooShortError, HTTPError, URLError
 from CPAC import __version__
+from CPAC.utils import versioning
 
 
 def docstring_parameter(*args, **kwargs):
@@ -71,4 +72,17 @@ def grab_docstring_dct(fn):
     return dct
 
 
+def version_report() -> str:
+    """A formatted block of versions included in CPAC's environment"""
+    version_list = []
+    for pkg, version in versioning.REPORTED.items():
+        version_list.append(f'{pkg}: {version}')
+        if pkg == 'Python':
+            version_list.append('  Python packages')
+            version_list.append('  ---------------')
+            for ppkg, pversion in versioning.PYTHON_PACKAGES.items():
+                version_list.append(f'  {ppkg}: {pversion}')
+    return '\n'.join(version_list)
+
+
 DOCS_URL_PREFIX = _docs_url_prefix()

CPAC/utils/versioning/__init__.py

@@ -0,0 +1,27 @@
+# Copyright (C) 2022  C-PAC Developers
+
+# This file is part of C-PAC.
+
+# C-PAC is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+
+# C-PAC is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
+# License for more details.
+
+# You should have received a copy of the GNU Lesser General Public
+# License along with C-PAC. If not, see <https://www.gnu.org/licenses/>.
+"""Gather and report dependency versions alphabetically"""
+import sys
+from pkg_resources import working_set
+
+PYTHON_PACKAGES = dict(sorted({
+  d.key: d.version for d in list(working_set)}.items()))
+REPORTED = dict(sorted({
+  'Python': sys.version
+}.items()))
+
+__all__ = ['PYTHON_PACKAGES', 'REPORTED']