luna/enodia-sentinal
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(packaging): document desktop GUI frontends and optdepends

Browse source 
The GUI frontends landed with README/CLI/operations docs but no packaging
coverage. Add a PACKAGING.md section with the command/script/requirement
table for both frontends, note why stdlib tkinter is still an optdepend
rather than a hard dependency, and record that packaging must not grant the
GUIs privileges beyond the operator's own account.

Add the matching PKGBUILD optdepends (`tk`, `pyside6`), plus
`python-pystray`/`python-pillow` for the tray applet, which were never
listed when it shipped. Also add `gui/` to the CLAUDE.md architecture notes
and state snapshot.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JX86xeoBJVBb16qHkDf53K
This commit is contained in:
Luna 2026-07-22 04:33:55 -07:00
parent 457c7604ba
commit 3dd82ab18b
No known key found for this signature in database
3 changed files with 38 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/PACKAGING.md
View file

@ -190,6 +190,31 @@ empty.
not installed to a system autostart path by default — desktop users copy it to
`~/.config/autostart/` themselves.
## Desktop GUI Frontends (optional)
Two windowed dashboards ship alongside the tray applet. Both are optional
frontends over the same local state the TUI and web console read; neither is
required by the daemon, and core runtime dependencies stay empty.
| Frontend | Command | Console script | Requirement |
| --- | --- | --- | --- |
| tkinter | `enodia-sentinel gui` | `enodia-sentinel-gui` | stdlib `tkinter` (distro `tk` / `python-tk` / `python-tkinter`) |
| Qt6 | `enodia-sentinel gui-qt` | `enodia-sentinel-gui-qt` | `[qt]` extra (`PySide6`) |
Notes:
- `tkinter` is stdlib but is packaged separately on most distros, so it is an
`optdepends` (Arch `tk`), never a hard dependency.
- The `[qt]` extra (`pip install 'enodia-sentinel[qt]'`) pulls in `PySide6`
only for the Qt frontend; the Arch package lists `pyside6` as an optdepend.
- Both GUIs are read-only over detection state and display response plans for
review only — packaging must not grant them privileges beyond what the
operator's own account has. Daemon start/stop/restart goes through
`systemctl` and prompts for polkit authorization as usual.
- Only `gui/app.py` (tkinter) and `gui/qt_app.py` (Qt) import GUI libraries;
`gui/model.py` stays import-clean so headless builders can run the test
suite without a display server or `PySide6` installed.
## Terminal TUI and Completion
The terminal dashboard is stdlib-only and available through