Release v26.32.3 : One-click auto update feature

Author: h0anle

.github/workflows/release.yml

@@ -0,0 +1,81 @@
+name: Build and publish release
+
+on:
+  push:
+    tags:
+      - "v[0-9]*"
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Verify release tag matches package version
+        env:
+          RELEASE_TAG: ${{ github.ref_name }}
+        run: |
+          python - <<'PY'
+          import os
+          import re
+          from pathlib import Path
+
+          tag = os.environ["RELEASE_TAG"]
+          match = re.fullmatch(r"v(\d+\.\d+\.\d+)", tag)
+          source = Path("spectroview/__init__.py").read_text(encoding="utf-8")
+          version = re.search(r'^VERSION\s*=\s*["\']([^"\']+)["\']', source, re.M)
+          if not match or version is None or version.group(1) != match.group(1):
+              raise SystemExit(
+                  "Release tags must be vMAJOR.MINOR.PATCH and match "
+                  "spectroview.VERSION."
+              )
+          PY
+
+      - name: Build and validate distributions
+        run: |
+          python -m pip install --upgrade build twine
+          python -m build
+          python -m twine check dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: python-distributions
+          path: dist/
+          if-no-files-found: error
+
+      - name: Create GitHub release and attach distributions
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "$GITHUB_REF_NAME" dist/* \
+            --repo "$GITHUB_REPOSITORY" \
+            --title "SPECTROview $GITHUB_REF_NAME" \
+            --notes "The installable wheel is attached below and is used by SPECTROview's automatic updater." \
+            --generate-notes \
+            --verify-tag
+
+  publish-pypi:
+    needs: build-and-release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/spectroview
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: python-distributions
+          path: dist/
+
+      - name: Publish distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -17,7 +17,6 @@ app/.DS_Store
 .exe
 env_spectroview/
 .vscode/
-.github/workflows/
 
 # MkDocs build output
 site/

docs/developer/index.md

@@ -370,15 +370,15 @@ self.v_maps_workspace.vm.switch_to_graphs_tab.connect(
 
 ### Overview
 
-`SPECTROview` ships a lightweight, opt-out update notification system that queries the GitHub Releases API in the background and displays a dismissable banner when a newer version is found.
+`SPECTROview` ships a lightweight, opt-out update system that queries the GitHub Releases API in the background and displays a dismissable banner when a newer version is found. The banner can download the wheel attached to that exact release, verify its GitHub SHA-256 digest when available, close the application, install the wheel with pip, and relaunch it.
 
 No extra dependency is required — only Python's built-in `urllib`.
 
 ### Key Files
 
 | File | Role |
 |------|------|
-| `model/m_update_checker.py` | `QThread` worker — performs the HTTP request and emits `update_available` |
+| `model/m_update_checker.py` | `QThread` workers for release checks and wheel downloads; creates the detached pip-install/restart helper |
 | `view/components/v_update_banner.py` | Slim 36 px banner widget inserted at position 0 of the central layout |
 | `model/m_settings.py` | Stores `enabled`, `skipped_version`, and `last_check_date` in `QSettings` |
 | `main.py` | Starts the thread via `QTimer.singleShot(2000, ...)` from `showEvent` |
@@ -392,15 +392,23 @@ sequenceDiagram
     participant Worker as UpdateCheckerWorker
     participant GitHub as api.github.com
     participant Banner as VUpdateBanner
+    participant Helper as Update helper
+    actor User
 
     Main->>Timer: showEvent → singleShot(2000)
     Timer->>Worker: _start_update_check() → worker.start()
     Worker->>GitHub: GET /repos/CEA-MetroCarac/SPECTROview/releases/latest
-    GitHub-->>Worker: JSON {tag_name, html_url, body}
+    GitHub-->>Worker: JSON {tag_name, html_url, body, assets[]}
     Worker->>Worker: compare versions
     alt newer version found
-        Worker-->>Main: update_available(tag, notes, url)
+        Worker-->>Main: update_available(tag, notes, url, wheel URL, SHA-256)
         Main->>Banner: insertWidget(0, VUpdateBanner(...))
+        User->>Banner: Update
+        Banner->>GitHub: Download release wheel in QThread
+        GitHub-->>Banner: Wheel bytes
+        Banner->>Helper: Start detached updater and close app
+        Helper->>Helper: pip install --upgrade wheel
+        Helper->>Main: Relaunch installed SPECTROview
     end
     Worker-->>Main: check_finished → set_last_check_date(today)
 ```
@@ -412,13 +420,21 @@ sequenceDiagram
 | **`QThread` instead of `QNetworkAccessManager`** | Pure Python `urllib` avoids Qt networking module complexity; thread is simpler to test |
 | **2-second startup delay** | Ensures the UI is fully painted before the network request starts |
 | **Once-per-day throttle** | Avoids redundant requests; the date is persisted via `QSettings` |
-| **Silent failure** | `URLError`, `OSError`, `json.JSONDecodeError` are all caught — offline machines see no error |
+| **Silent check failure** | `URLError`, `OSError`, `json.JSONDecodeError` are caught — offline machines see no error |
 | **Version comparison via tuples** | `_parse_version('v26.29.0') → (26, 29, 0)` handles `v`-prefixed tags and non-numeric parts gracefully |
+| **Release asset source** | GitHub provides the version, release notes, wheel URL, and integrity digest in one public API response; PyPI remains the normal package-install channel |
+| **Detached helper** | The helper waits for Qt to exit, installs with the launching interpreter, then clears `PYTHONPATH`/`PYTHONHOME` and restarts from a temporary working directory so a checkout cannot shadow the freshly installed package |
 | **Skip vs Dismiss** | *Skip* persists the exact tag — the banner re-appears for the next release. *Dismiss* hides only for the session |
 
 ### Adding / Modifying the Checker
 
-To change the API endpoint (e.g., to query PyPI instead), edit `GITHUB_API_URL` in `m_update_checker.py` and adjust the JSON key extraction in `UpdateCheckerWorker.run()`.
+Release automation lives in `.github/workflows/release.yml`. Pushing a `vMAJOR.MINOR.PATCH` tag whose value matches `spectroview.VERSION` builds the wheel and source distribution, attaches them to a GitHub release, and publishes them to PyPI through the `pypi` environment's Trusted Publisher.
+
+Before the first automated PyPI publication, register a Trusted Publisher for
+`CEA-MetroCarac/SPECTROview` in the PyPI project's **Publishing** settings with
+workflow filename `release.yml` and environment `pypi`. This lets GitHub Actions
+obtain a short-lived publishing token without storing a long-lived PyPI API token
+in the repository.
 
 To add a "disable updates" toggle to the Settings dialog, bind `MSettings.set_check_for_updates()` to a `QCheckBox` in `v_settings.py` — the `_start_update_check()` method in `main.py` already reads this flag before starting the thread.
 

spectroview/__init__.py

@@ -6,7 +6,7 @@
 # The app uses PySide6 throughout, but superqt (used for QLabeledDoubleRangeSlider)
 os.environ.setdefault("QT_API", "pyside6")
 
-VERSION = "26.32.2"
+VERSION = "26.35.1"
 
 
 TEXT_EXPIRE = (

spectroview/main.py

@@ -19,7 +19,13 @@
 from spectroview.model.m_file_converter import MFileConverter
 from spectroview.model.m_spc import SpcReader
 from spectroview.model.m_settings import MSettings
-from spectroview.model.m_update_checker import UpdateCheckerWorker
+from spectroview.model.m_update_checker import (
+    UpdateCheckerWorker,
+    UpdateDownloadWorker,
+    UpdateInstallationError,
+    get_update_python_executable,
+    install_update_and_restart,
+)
 
 from spectroview.viewmodel.vm_settings import VMSettings
 
@@ -86,6 +92,7 @@ def init_ui(self):
 
         # ── Update notification banner (created lazily when an update is detected) ──
         self._update_banner = None
+        self._update_download_worker = None
 
         # Main Tab Widget
         self.tabWidget = QTabWidget(central)
@@ -671,7 +678,9 @@ def _start_update_check(self):
         self._checker.update_available.connect(self._on_update_available)
         self._checker.start()
 
-    def _on_update_available(self, tag: str, notes: str, html_url: str):
+    def _on_update_available(
+        self, tag: str, notes: str, html_url: str, wheel_url: str, wheel_sha256: str
+    ):
         """Show the update banner when a newer version is found on GitHub."""
         # Never show if the user already skipped this exact version
         if self.settings.get_skipped_version() == tag:
@@ -680,23 +689,33 @@ def _on_update_available(self, tag: str, notes: str, html_url: str):
         if self._update_banner is not None:
             return   # already showing
 
+        self._show_update_banner(tag, html_url, wheel_url, wheel_sha256)
+
+    def _show_update_banner(
+        self, tag: str, html_url: str, wheel_url: str, wheel_sha256: str
+    ) -> None:
+        """Create and insert the single update banner above the workspace tabs."""
         banner = VUpdateBanner(
             tag=tag,
             html_url=html_url,
             on_skip=self.settings.set_skipped_version,
             on_dismiss=self._hide_banner,
+            on_update=self._download_and_install_update,
+            wheel_url=wheel_url,
+            wheel_sha256=wheel_sha256,
             parent=self.centralWidget(),
         )
-        # Apply current theme
         banner.apply_theme(self.settings.get_theme())
-
-        # Insert banner into the layout at position 0 (above tab widget)
         self.centralWidget().layout().insertWidget(0, banner)
         self._update_banner = banner
 
     def _hide_banner(self):
-        """Reset the banner reference (the widget removes itself via deleteLater)."""
+        """Remove and dispose of the current update banner."""
+        banner = self._update_banner
         self._update_banner = None
+        if banner is not None:
+            self.centralWidget().layout().removeWidget(banner)
+            banner.deleteLater()
 
     def _manual_update_check(self):
         """User clicked 'Check for updates' in the menu bar — always runs (no throttle)."""
@@ -707,23 +726,71 @@ def _manual_update_check(self):
         self._manual_checker.check_finished.connect(self._on_manual_check_done)
         self._manual_checker.start()
 
-    def _on_manual_update_found(self, tag: str, notes: str, html_url: str):
+    def _on_manual_update_found(
+        self, tag: str, notes: str, html_url: str, wheel_url: str, wheel_sha256: str
+    ):
         """A newer version was found during a user-initiated check."""
         self._manual_check_found_update = True
         # Show banner even if user previously skipped this version
         if self._update_banner is not None:
             return
 
-        banner = VUpdateBanner(
-            tag=tag,
-            html_url=html_url,
-            on_skip=self.settings.set_skipped_version,
-            on_dismiss=self._hide_banner,
-            parent=self.centralWidget(),
+        self._show_update_banner(tag, html_url, wheel_url, wheel_sha256)
+
+    def _download_and_install_update(
+        self, _tag: str, wheel_url: str, wheel_sha256: str
+    ) -> None:
+        """Download the announced release wheel, then hand installation to the helper."""
+        if self._update_download_worker is not None:
+            return
+        try:
+            get_update_python_executable()
+        except UpdateInstallationError as error:
+            QMessageBox.warning(self, "Automatic update unavailable", str(error))
+            return
+
+        if self._update_banner is not None:
+            self._update_banner.set_download_progress(-1)
+        worker = UpdateDownloadWorker(wheel_url, wheel_sha256, self)
+        worker.progress_changed.connect(self._on_update_download_progress)
+        worker.download_finished.connect(self._on_update_download_finished)
+        worker.download_failed.connect(self._on_update_download_failed)
+        self._update_download_worker = worker
+        worker.start()
+
+    def _on_update_download_progress(self, percent: int) -> None:
+        if self._update_banner is not None:
+            self._update_banner.set_download_progress(percent)
+
+    def _on_update_download_finished(self, wheel_path: str) -> None:
+        """Schedule installation after the Qt process exits, then close this instance."""
+        self._release_update_download_worker()
+        try:
+            install_update_and_restart(Path(wheel_path))
+        except (OSError, UpdateInstallationError) as error:
+            Path(wheel_path).unlink(missing_ok=True)
+            self._show_update_download_error(str(error))
+            return
+        self.close()
+
+    def _on_update_download_failed(self, error: str) -> None:
+        self._release_update_download_worker()
+        self._show_update_download_error(error)
+
+    def _release_update_download_worker(self) -> None:
+        worker = self._update_download_worker
+        self._update_download_worker = None
+        if worker is not None:
+            worker.deleteLater()
+
+    def _show_update_download_error(self, error: str) -> None:
+        if self._update_banner is not None:
+            self._update_banner.set_update_error()
+        QMessageBox.warning(
+            self,
+            "Update download failed",
+            f"SPECTROview could not download the update. Please try again or install it manually.\n\n{error}",
         )
-        banner.apply_theme(self.settings.get_theme())
-        self.centralWidget().layout().insertWidget(0, banner)
-        self._update_banner = banner
 
     def _on_manual_check_done(self):
         """Show 'up to date' message if the manual check found nothing new."""