Os standalone installers (with a GUI)

executables/README.md

@@ -0,0 +1,39 @@
+# Pyinstaller one folder executable
+
+- pyvis templates were not copied, so make these explicit (see [this](https://stackoverflow.com/a/72687433/9684872))
+
+```bash
+# from this README folder
+pyinstaller -D --collect-all pyvis --collect-all streamlit --collect-all  st_aggrid  -n vuegen ../src/vuegen/__main__.py
+```
+
+```bash
+# other pyinstaller options
+--noconfirm # is used to avoid the prompt for overwriting the existing dist folder
+```
+
+## Pyinstaller options
+
+```bash
+What to generate:
+  -D, --onedir          Create a one-folder bundle containing an executable (default)
+  -F, --onefile         Create a one-file bundled executable.
+  --specpath DIR        Folder to store the generated spec file (default: current directory)
+  -n NAME, --name NAME  Name to assign to the bundled app and spec file (default: first script's basename)
+Windows and macOS specific options:
+  -c, --console, --nowindowed
+                        Open a console window for standard i/o (default). On Windows this option has no effect if the first script is a
+                        '.pyw' file.
+  -w, --windowed, --noconsole
+                        Windows and macOS: do not provide a console window for standard i/o. On macOS this also triggers building a
+                        macOS .app bundle. On Windows this option is automatically set if the first script is a '.pyw' file. This option
+                        is ignored on *NIX systems.
+```
+
+## Using bundled executable
+
+try using basic example
+
+```bash
+./dist/vuegen/vuegen -d  ../docs/example_data/Basic_example_vuegen_demo_notebook -st_autorun
+```

executables/vuegen.spec

@@ -0,0 +1,55 @@
+# -*- mode: python ; coding: utf-8 -*-
+from PyInstaller.utils.hooks import collect_all
+
+datas = []
+binaries = []
+hiddenimports = []
+tmp_ret = collect_all('pyvis')
+datas += tmp_ret[0]; binaries += tmp_ret[1]; hiddenimports += tmp_ret[2]
+tmp_ret = collect_all('streamlit')
+datas += tmp_ret[0]; binaries += tmp_ret[1]; hiddenimports += tmp_ret[2]
+tmp_ret = collect_all('st_aggrid')
+datas += tmp_ret[0]; binaries += tmp_ret[1]; hiddenimports += tmp_ret[2]
+
+
+a = Analysis(
+    ['../src/vuegen/__main__.py'],
+    pathex=[],
+    binaries=binaries,
+    datas=datas,
+    hiddenimports=hiddenimports,
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=[],
+    noarchive=False,
+    optimize=0,
+)
+pyz = PYZ(a.pure)
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    [],
+    exclude_binaries=True,
+    name='vuegen',
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    console=True,
+    disable_windowed_traceback=False,
+    argv_emulation=False,
+    target_arch=None,
+    codesign_identity=None,
+    entitlements_file=None,
+)
+coll = COLLECT(
+    exe,
+    a.binaries,
+    a.datas,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    name='vuegen',
+)

gui/README.md

@@ -0,0 +1,39 @@
+# VueGen GUI
+
+## Local execution of the GUI
+
+Install required dependencies from package
+
+```bash
+pip install 'vuegen[gui]'
+# or with local repo
+pip install '.[gui]'
+# or for local editable install
+pip install -e '.[gui]'
+```
+
+Can be started locally with
+
+```bash
+# from within gui directory
+python app.py
+```
+
+## Build executable GUI
+
+For now do not add the `--windowed` option, as it will not show the console output,
+which is useful for debugging and especially terminating any running processes, e.g.
+as the streamlit server and the GUI itself.
+
+```bash
+# from this README folder
+pyinstaller \
+-n vuegen_gui \
+--no-confirm \
+--onedir \
+--collect-all pyvis \
+--collect-all streamlit \
+--collect-all  st_aggrid  \
+--collect-all customtkinter \
+app.py
+```

gui/app.py

@@ -0,0 +1,162 @@
+"""GUI for vuegen command-line tool.
+
+usage: VueGen [-h] [-c CONFIG] [-dir DIRECTORY] [-rt REPORT_TYPE]
+              [-st_autorun]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -c CONFIG, --config CONFIG
+                        Path to the YAML configuration file.
+  -dir DIRECTORY, --directory DIRECTORY
+                        Path to the directory from which the YAML
+                        config will be inferred.
+  -rt REPORT_TYPE, --report_type REPORT_TYPE
+                        Type of the report to generate (streamlit,
+                        html, pdf, docx, odt, revealjs, pptx, or
+                        jupyter).
+  -st_autorun, --streamlit_autorun
+                        Automatically run the Streamlit app after
+                        report generation.
+"""
+
+import sys
+import tkinter as tk
+
+import customtkinter
+
+from vuegen.__main__ import main
+from vuegen.report import ReportType
+
+customtkinter.set_appearance_mode("system")
+customtkinter.set_default_color_theme("dark-blue")
+
+
+##########################################################################################
+# callbacks
+def create_run_vuegen(is_dir, config_path, report_type, run_streamlit):
+    def inner():
+        args = ["vuegen"]
+        if is_dir:
+            args.append("--directory")
+        else:
+            args.append("--config")
+        args.append(config_path.get())
+        args.append("--report_type")
+        args.append(report_type.get())
+        if run_streamlit:
+            args.append("--streamlit_autorun")
+        print("args:", args)
+        sys.argv = args
+        main()  # Call the main function from vuegen
+
+    return inner
+
+
+def optionmenu_callback(choice):
+    """Good for logging changes?"""
+    print("optionmenu dropdown clicked:", choice)
+
+
+def radiobutton_event(value):
+    def radio_button_callback():
+        print("radiobutton toggled, current value:", value.get())
+
+    return radio_button_callback
+
+
+##########################################################################################
+# APP
+app = customtkinter.CTk()
+app.geometry("460x400")
+app.title("VueGen GUI")
+
+##########################################################################################
+# Config or directory input
+ctk_label_config = customtkinter.CTkLabel(
+    app,
+    text="Add path to config file or directory. Select radio button accordingly",
+)
+ctk_label_config.grid(row=0, column=0, columnspan=2, padx=20, pady=20)
+is_dir = tk.IntVar(value=1)
+callback_radio_config = radiobutton_event(is_dir)
+ctk_radio_config_0 = customtkinter.CTkRadioButton(
+    app,
+    text="Use config",
+    command=callback_radio_config,
+    variable=is_dir,
+    value=0,
+)
+ctk_radio_config_0.grid(row=1, column=0, padx=20, pady=2)
+ctk_radio_config_1 = customtkinter.CTkRadioButton(
+    app,
+    text="Use dir",
+    command=callback_radio_config,
+    variable=is_dir,
+    value=1,
+)
+ctk_radio_config_1.grid(row=1, column=1, padx=20, pady=2)
+
+config_path = tk.StringVar()
+config_path_entry = customtkinter.CTkEntry(
+    app,
+    width=400,
+    textvariable=config_path,
+)
+config_path_entry.grid(row=2, column=0, columnspan=2, padx=20, pady=10)
+
+##########################################################################################
+# Report type dropdown
+# - get list of report types from Enum
+report_types = [report_type.value.lower() for report_type in ReportType]
+
+ctk_label_report = customtkinter.CTkLabel(
+    app,
+    text="Select type of report to generate (use streamlit for now)",
+)
+ctk_label_report.grid(row=3, column=0, columnspan=2, padx=20, pady=20)
+report_type = tk.StringVar(value=report_types[0])
+report_dropdown = customtkinter.CTkOptionMenu(
+    app,
+    values=report_types,
+    variable=report_type,
+    command=optionmenu_callback,
+)
+report_dropdown.grid(row=4, column=0, columnspan=2, padx=20, pady=20)
+
+_report_type = report_dropdown.get()
+print("report_type value:", _report_type)
+
+##########################################################################################
+# Run Streamlit radio button
+run_streamlit = tk.IntVar(value=1)
+callback_radio_st_run = radiobutton_event(run_streamlit)
+ctk_radio_st_autorun_1 = customtkinter.CTkRadioButton(
+    app,
+    text="autorun streamlit",
+    value=1,
+    variable=run_streamlit,
+    command=callback_radio_st_run,
+)
+ctk_radio_st_autorun_1.grid(row=5, column=0, padx=20, pady=20)
+ctk_radio_st_autorun_0 = customtkinter.CTkRadioButton(
+    app,
+    text="skip starting streamlit",
+    value=0,
+    variable=run_streamlit,
+    command=callback_radio_st_run,
+)
+ctk_radio_st_autorun_0.grid(row=5, column=1, padx=20, pady=20)
+
+##########################################################################################
+# Run VueGen button
+run_vuegen = create_run_vuegen(is_dir, config_path, report_type, run_streamlit)
+run_button = customtkinter.CTkButton(
+    app,
+    text="Run VueGen",
+    command=run_vuegen,
+)
+run_button.grid(row=6, column=0, columnspan=2, padx=20, pady=20)
+
+##########################################################################################
+# Run the app in the mainloop
+app.mainloop()

pyproject.toml

@@ -56,6 +56,7 @@ build-backend = "poetry_dynamic_versioning.backend"
 # https://stackoverflow.com/a/60990574/9684872
 [tool.poetry.extras]
 docs = ["sphinx", "sphinx-book-theme", "myst-nb", "ipywidgets", "sphinx-new-tab-link", "jupytext"]
+gui = ["customtkinter"]
 
 [tool.poetry.scripts]
 # https://python-poetry.org/docs/pyproject/#scripts

src/vuegen/quarto_reportview.py

@@ -1,5 +1,6 @@
 import os
 import subprocess
+import sys
 from pathlib import Path
 from typing import List
 
@@ -20,6 +21,12 @@ class QuartoReportView(r.ReportView):
 
     def __init__(self, report: r.Report, report_type: r.ReportType):
         super().__init__(report=report, report_type=report_type)
+        self.BUNDLED_EXECUTION = False
+        if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
+            self.report.logger.info("running in a PyInstaller bundle")
+            self.BUNDLED_EXECUTION = True
+        else:
+            self.report.logger.info("running in a normal Python process")
 
     def generate_report(
         self, output_dir: str = BASE_DIR, static_dir: str = STATIC_FILES_DIR
@@ -155,22 +162,32 @@ def run_report(self, output_dir: str = BASE_DIR) -> None:
             The folder where the report was generated (default is 'sections').
         """
         try:
-            subprocess.run(
-                ["quarto", "render", os.path.join(output_dir, f"{self.BASE_DIR}.qmd")],
-                check=True,
-            )
-            if self.report_type == r.ReportType.JUPYTER:
+            if not self.BUNDLED_EXECUTION:
                 subprocess.run(
                     [
                         "quarto",
-                        "convert",
+                        "render",
                         os.path.join(output_dir, f"{self.BASE_DIR}.qmd"),
                     ],
                     check=True,
                 )
-            self.report.logger.info(
-                f"'{self.report.title}' '{self.report_type}' report rendered"
-            )
+                if self.report_type == r.ReportType.JUPYTER:
+                    subprocess.run(
+                        [
+                            "quarto",
+                            "convert",
+                            os.path.join(output_dir, f"{self.BASE_DIR}.qmd"),
+                        ],
+                        check=True,
+                    )
+                self.report.logger.info(
+                    f"'{self.report.title}' '{self.report_type}' report rendered"
+                )
+            else:
+                self.report.logger.info(
+                    f"Quarto report '{self.report.title}' '{self.report_type}' cannot "
+                    "be run in a PyInstaller bundle"
+                )
         except subprocess.CalledProcessError as e:
             self.report.logger.error(
                 f"Error running '{self.report.title}' {self.report_type} report: {str(e)}"