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 /plugins/base_plugin.py | |
| 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 'plugins/base_plugin.py')
| -rw-r--r-- | plugins/base_plugin.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/plugins/base_plugin.py b/plugins/base_plugin.py index 2dbb56d..d728d08 100644 --- a/plugins/base_plugin.py +++ b/plugins/base_plugin.py @@ -1,7 +1,7 @@ """ plugins/base_plugin.py -Abstract base class for all LabDAQ plugins. +Abstract base class for all LabUI plugins. To create a plugin: 1. Create a directory under plugins/ e.g. plugins/my_plugin/ @@ -25,7 +25,7 @@ Integration points (all optional — override only what you need): get_devices() → list of BaseDevice auto-added to registry + engine get_filter_classes() → {name: FilterBase cls} custom signal pipeline filters get_settings_widget() → QWidget | None shown in Settings > Plugins - get_save_state() → dict persisted in .labdaq profiles + get_save_state() → dict persisted in .labui profiles apply_save_state(dict) restore from profile """ @@ -68,7 +68,7 @@ class PluginAction: class LabPlugin(ABC): """ - Abstract base for all LabDAQ plugins. + Abstract base for all LabUI plugins. Subclass this, set the metadata properties, and override whatever integration hooks your plugin needs. @@ -129,7 +129,7 @@ class LabPlugin(ABC): # ── Profile persistence ─────────────────────────────────────────────── def get_save_state(self) -> Dict[str, Any]: - """Return a JSON-serialisable dict, saved with the .labdaq profile.""" + """Return a JSON-serialisable dict, saved with the .labui profile.""" return {} def apply_save_state(self, state: Dict[str, Any]) -> None: |
