diff options
| author | Christian Kolset <christian.kolset@gmail.com> | 2026-08-01 19:06:36 -0600 |
|---|---|---|
| committer | Christian Kolset <christian.kolset@gmail.com> | 2026-08-01 19:06:36 -0600 |
| commit | 0aa59c13af65beeae104662593b21ba4d8a37789 (patch) | |
| tree | 17a1e6bd92a3a236bef0bca2e11ca7a875ba6caa /docs/plugin-development.md | |
| parent | bfbdd0c19910f464e779fa64cc0ec8590f8e37c1 (diff) | |
Rename LabDAQ → LabUI and overhaul plugin system
Branding:
- Rename app, window title, file extension (.labdaq → .labui), user data
dirs (~/.labui/), spec file (labdaq.spec → labui.spec), and APP_NAME
throughout all source, docs, and config files
Plugin system:
- Plugins no longer bundled in the PyInstaller build — installed at
runtime by users via Settings → Plugins → Install Plugin (zip)
- PluginManager now takes user_dir + extra_scan_dirs; user plugins live
in ~/.labui/plugins/, dev scan additionally covers project plugins/
- install_from_zip / uninstall / is_user_installed added to PluginManager
- vendor/ dir inside plugin zips: prepended to sys.path at load time so
plugins can ship their own deps without requiring pip on end-user machine
- source_url field in manifest.json: shown as Download button in the
missing-plugins dialog when a profile requires an absent plugin
- Frozen-app pip install now targets ~/.labui/plugin_packages/ using a
real system Python (sys.executable is the exe in frozen builds)
Profile loading:
- Profile now stores plugins_manifest snapshot (id, name, version,
source_url) alongside plugins_enabled
- On load, missing or dep-broken plugins trigger MissingPluginsDialog
before the rest of the profile is applied; user can install from zip
or download via source_url in-dialog, or cancel the load
- Plugin reconciliation only enables installed plugins — missing ones
are not written to enabled.json
UI:
- Version label added to status bar (bottom-right, muted colour)
- Settings → Plugins tab: Install Plugin… button, per-plugin Remove
button for user-installed plugins, live list refresh after install/remove
Docs:
- New docs/building.md covers the full release pipeline
- docs/plugin-development.md updated for new install flow, vendoring,
source_url, profile behaviour, and distribution instructions
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Diffstat (limited to 'docs/plugin-development.md')
| -rw-r--r-- | docs/plugin-development.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/plugin-development.md b/docs/plugin-development.md index b0c3a63..8722376 100644 --- a/docs/plugin-development.md +++ b/docs/plugin-development.md @@ -1,4 +1,4 @@ -# LabDAQ Plugin Development Guide +# LabUI Plugin Development Guide Plugins live under `plugins/` as self-contained directories. The app discovers them automatically; the user enables or disables them in **Settings → Plugins**. A disabled plugin leaves zero trace in the UI. @@ -287,7 +287,7 @@ The widget is created once when the plugin loads. Apply changes immediately (no ### 5.5 Profile persistence -`.labdaq` profiles save the **enabled plugin list** automatically — loading a profile enables/disables plugins to match the saved state. Per-plugin configuration state is also saved if you implement these two methods. +`.labui` profiles save the **enabled plugin list** automatically — loading a profile enables/disables plugins to match the saved state. Per-plugin configuration state is also saved if you implement these two methods. ```python def get_save_state(self) -> dict: @@ -436,7 +436,7 @@ This plugin adds a sine-wave virtual channel and a toolbar button to toggle a di "name": "Sine Demo", "version": "1.0.0", "description": "Virtual sine-wave channel for testing.", - "author": "LabDAQ", + "author": "LabUI", "entry_point": "plugin.SineDemoPlugin" } ``` @@ -537,10 +537,10 @@ Import Qt widgets inside methods or inside `on_load`. This avoids import errors Stop background threads (`_running = False; _thread.join()`), disconnect signals, close windows. The app calls `on_unload()` both on user disable and on application close. **Filter `__init__` params must be JSON-serialisable.** -They are written into `.labdaq` profiles via `to_dict()` and reconstructed via `filter_from_dict()`. Stick to `int`, `float`, `str`, `bool`. +They are written into `.labui` profiles via `to_dict()` and reconstructed via `filter_from_dict()`. Stick to `int`, `float`, `str`, `bool`. **Profiles enable and disable plugins.** -Loading a `.labdaq` profile reconciles plugin state: plugins not in the profile's enabled list are disabled, plugins in the list are enabled. `apply_save_state` is called after the plugin is loaded. `plugins/enabled.json` is updated to match. +Loading a `.labui` profile reconciles plugin state: plugins not in the profile's enabled list are disabled, plugins in the list are enabled. `apply_save_state` is called after the plugin is loaded. `plugins/enabled.json` is updated to match. **Enabled state persists across restarts.** `plugins/enabled.json` is written every time a toggle changes. Delete it to reset all plugins to disabled. |
