mirror of
https://github.com/PR0M3TH3AN/SeedPass.git
synced 2025-09-07 14:58:56 +00:00
Add GUI getting started docs
This commit is contained in:
31
README.md
31
README.md
@@ -229,6 +229,37 @@ seedpass list --filter totp
|
||||
|
||||
For additional command examples, see [docs/advanced_cli.md](docs/advanced_cli.md). Details on the REST API can be found in [docs/api_reference.md](docs/api_reference.md).
|
||||
|
||||
### Getting Started with the GUI
|
||||
|
||||
SeedPass also ships with a simple BeeWare desktop interface. Launch it from
|
||||
your virtual environment using:
|
||||
|
||||
```bash
|
||||
python -m seedpass_gui
|
||||
```
|
||||
|
||||
If installed globally, you can run the `seedpass-gui` entry point instead:
|
||||
|
||||
```bash
|
||||
seedpass-gui
|
||||
```
|
||||
|
||||
The GUI works with the same vault and configuration files as the CLI.
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
core["seedpass.core"]
|
||||
cli["CLI"]
|
||||
api["FastAPI server"]
|
||||
gui["BeeWare GUI"]
|
||||
ext["Browser Extension"]
|
||||
|
||||
cli --> core
|
||||
gui --> core
|
||||
api --> core
|
||||
ext --> api
|
||||
```
|
||||
|
||||
### Vault JSON Layout
|
||||
|
||||
The encrypted index file `seedpass_entries_db.json.enc` begins with `schema_version` `2` and stores an `entries` map keyed by entry numbers.
|
||||
|
@@ -2,6 +2,36 @@
|
||||
|
||||
SeedPass ships with a proof-of-concept graphical interface built using [BeeWare](https://beeware.org). The GUI interacts with the same core services as the CLI by instantiating wrappers around `PasswordManager`.
|
||||
|
||||
## Getting Started with the GUI
|
||||
|
||||
After installing the project dependencies, launch the desktop interface with:
|
||||
|
||||
```bash
|
||||
python -m seedpass_gui
|
||||
```
|
||||
|
||||
If you installed the package globally, you can use the provided entry point:
|
||||
|
||||
```bash
|
||||
seedpass-gui
|
||||
```
|
||||
|
||||
The GUI shares the same encrypted vault and configuration as the command line tool.
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
core["seedpass.core"]
|
||||
cli["CLI"]
|
||||
api["FastAPI server"]
|
||||
gui["BeeWare GUI"]
|
||||
ext["Browser Extension"]
|
||||
|
||||
cli --> core
|
||||
gui --> core
|
||||
api --> core
|
||||
ext --> api
|
||||
```
|
||||
|
||||
## VaultService and EntryService
|
||||
|
||||
`VaultService` provides thread-safe access to vault operations like exporting, importing, unlocking and locking the vault. `EntryService` exposes methods for listing, searching and modifying entries. Both classes live in `seedpass.core.api` and hold a `PasswordManager` instance protected by a `threading.Lock` to ensure safe concurrent access.
|
||||
|
Reference in New Issue
Block a user