Add manifest generation and update build process in DataLab

Author: PierreRaybaut

DataLab.spec

@@ -9,6 +9,7 @@ datas = collect_data_files('datalab') + [('datalab\\plugins', 'datalab\\plugins'
 datas += collect_data_files('guidata') + collect_data_files('plotpy')
 datas += collect_data_files('sigima')
 datas += copy_metadata('imageio')
+datas += [('manifest.json', '.')]
 
 a = Analysis(
     ['datalab\\start.pyw'],

datalab/widgets/instconfviewer.py

@@ -6,11 +6,13 @@
 
 from __future__ import annotations
 
+import json
 import locale
 import os
 import platform
 import sys
 from importlib.metadata import distributions
+from pathlib import Path
 
 from guidata.configtools import get_icon
 from guidata.qthelpers import exec_dialog
@@ -52,6 +54,45 @@ def get_installed_package_info() -> str:
     return os.linesep.join(result_lines)
 
 
+def get_manifest_package_info(manifest_path: Path) -> str:
+    """Get the list of packages from the build manifest file
+
+    Args:
+        manifest_path: Path to the manifest.json file
+
+    Returns:
+        Formatted string with package list and build information
+    """
+    try:
+        with open(manifest_path, "r", encoding="utf-8") as f:
+            manifest = json.load(f)
+
+        packages = list(manifest["packages"].items())
+        packages.sort(key=lambda x: x[0].lower())
+
+        # Determine column widths
+        name_width = max(len(name) for name, _ in packages)
+        version_width = max(len(version) for _, version in packages)
+
+        header = f"{'Package':{name_width}}   {'Version':{version_width}}"
+        separator = f"{'-' * name_width}   {'-' * version_width}"
+        result_lines = [
+            f"Build time: {manifest['build_time']}",
+            f"Python version: {manifest['python_version']}",
+            f"Build system: {manifest['system']} {manifest['release']}",
+            f"Architecture: {manifest['architecture']}",
+            "",
+            header,
+            separator,
+        ]
+        for name, version in packages:
+            result_lines.append(f"{name:{name_width}}   {version:{version_width}}")
+
+        return os.linesep.join(result_lines)
+    except Exception as e:
+        return f"Error reading manifest file: {e}"
+
+
 def get_install_info() -> str:
     """Get DataLab installation informations
 
@@ -62,7 +103,15 @@ def get_install_info() -> str:
         #  Stand-alone version
         more_info = "This is the Stand-alone version of DataLab."
         more_info += os.linesep * 2
-    more_info = get_installed_package_info()
+
+        # Try to read manifest file from executable root directory
+        manifest_path = Path(sys.executable).parent / "manifest.json"
+        if manifest_path.exists():
+            more_info += get_manifest_package_info(manifest_path)
+        else:
+            more_info += "Manifest file not found."
+    else:
+        more_info = get_installed_package_info()
     info = os.linesep.join(
         [
             f"DataLab v{datalab.__version__}",

scripts/build_exe.bat

@@ -45,6 +45,9 @@ for %%s in (16 24 32 48 128 256) do (
 magick "%RESPATH%\tmp-*.png" "%RESPATH%\DataLab.ico"
 del "%RESPATH%\tmp-*.png"
 
+@REM Generate build manifest
+%PYTHON% scripts\generate_manifest.py
+
 @REM Building executable
 %PYTHON% -m PyInstaller DataLab.spec --noconfirm --clean
 

scripts/generate_manifest.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.
+
+"""
+Generate build manifest for DataLab executable
+
+This script generates a JSON manifest file containing information about the build
+environment, Python version, system information, and all installed packages with
+their versions. This manifest is then included in the frozen executable and displayed
+in the installation configuration viewer.
+"""
+
+import json
+import platform
+from datetime import datetime
+from importlib.metadata import distributions
+
+
+def generate_manifest(file_path="manifest.json"):
+    """Generate a manifest file with build information and package list
+
+    Args:
+        file_path: Path to the output manifest JSON file (default: "manifest.json")
+    """
+    manifest = {
+        "build_time": datetime.utcnow().isoformat() + "Z",
+        "python_version": platform.python_version(),
+        "system": platform.system(),
+        "release": platform.release(),
+        "architecture": platform.machine(),
+        "packages": {dist.metadata["Name"]: dist.version for dist in distributions()},
+    }
+
+    with open(file_path, "w", encoding="utf-8") as f:
+        json.dump(manifest, f, indent=2)
+
+    print(f"Manifest written to {file_path}")
+    print(f"  Build time: {manifest['build_time']}")
+    print(f"  Python version: {manifest['python_version']}")
+    print(f"  System: {manifest['system']} {manifest['release']}")
+    print(f"  Architecture: {manifest['architecture']}")
+    print(f"  Total packages: {len(manifest['packages'])}")
+
+
+if __name__ == "__main__":
+    generate_manifest()