Merge pull request #651 from PR0M3TH3AN/codex/update-gui-getting-started-documentation

Add Toga backend note
This commit is contained in:
thePR0M3TH3AN authored and GitHub committed 2025-07-19 12:15:16 -04:00
commit ade572815a
2 files changed
+31

No files matched your search

+16
View File
@@ -241,6 +241,22 @@ python -m seedpass_gui
seedpass-gui
```
To display the interface, you must also install the Toga backend for your
platform. Only `toga-core` and the headless `toga-dummy` backend are included
in the requirements file. Depending on your operating system install one of the
following packages:
```bash
# Linux
pip install toga-gtk
# Windows
pip install toga-winforms
# macOS
pip install toga-cocoa
```
The GUI works with the same vault and configuration files as the CLI.
```mermaid
@@ -14,6 +14,21 @@ python -m seedpass_gui
seedpass-gui
```
Only the headless `toga-dummy` backend ships with the project for automated
tests. To actually display windows you need a platform-specific backend such as
`toga-gtk`, `toga-winforms`, or `toga-cocoa`.
```bash
# Linux
pip install toga-gtk
# Windows
pip install toga-winforms
# macOS
pip install toga-cocoa
```
The GUI shares the same encrypted vault and configuration as the command line tool.
To generate a packaged binary, run `briefcase build` (after the initial `briefcase create`).