thePR0M3TH3AN/seedPass
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/SeedPass.git synced 2025-09-09 07:48:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #544 from PR0M3TH3AN/codex/update-api-reference-for-notifications

Browse Source 
Update docs with notification box info
This commit is contained in:
thePR0M3TH3AN
2025-07-14 16:06:42 -04:00
committed by GitHub
parent 7e43b5f7f5 300cf4a0a1
commit 8c56bfef66
4 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -65,6 +65,9 @@ SeedPass now uses the `portalocker` library for cross-platform file locking. No
- **Relay Management:** List, add, remove or reset configured Nostr relays. - **Relay Management:** List, add, remove or reset configured Nostr relays.
- **Offline Mode:** Disable all Nostr communication for local-only operation. - **Offline Mode:** Disable all Nostr communication for local-only operation.
A small on-screen notification area now shows queued messages for 10 seconds
before fading.
## Prerequisites ## Prerequisites
- **Python 3.8+** (3.11 or 3.12 recommended): Install Python from [python.org](https://www.python.org/downloads/) and be sure to check **"Add Python to PATH"** during setup. Using Python 3.13 is currently discouraged because some dependencies do not ship wheels for it yet, which can cause build failures on Windows unless you install the Visual C++ Build Tools. - **Python 3.8+** (3.11 or 3.12 recommended): Install Python from [python.org](https://www.python.org/downloads/) and be sure to check **"Add Python to PATH"** during setup. Using Python 3.13 is currently discouraged because some dependencies do not ship wheels for it yet, which can cause build failures on Windows unless you install the Visual C++ Build Tools.

6
docs/docs/content/01-getting-started/02-api_reference.md
View File

@@ -31,7 +31,7 @@ Keep this token secret. Every request must include it in the `Authorization` hea
- `GET /api/v1/totp/export` – Export all TOTP entries as JSON. - `GET /api/v1/totp/export` – Export all TOTP entries as JSON.
- `GET /api/v1/totp` – Return current TOTP codes and remaining time. - `GET /api/v1/totp` – Return current TOTP codes and remaining time.
- `GET /api/v1/stats` – Return statistics about the active seed profile. - `GET /api/v1/stats` – Return statistics about the active seed profile.
- `GET /api/v1/notifications` – Retrieve and clear queued notifications. - `GET /api/v1/notifications` – Retrieve and clear queued notifications. Messages appear in the persistent notification box but remain queued until fetched.
- `GET /api/v1/parent-seed` – Reveal the parent seed or save it with `?file=`. - `GET /api/v1/parent-seed` – Reveal the parent seed or save it with `?file=`.
- `GET /api/v1/nostr/pubkey` – Fetch the Nostr public key for the active seed. - `GET /api/v1/nostr/pubkey` – Fetch the Nostr public key for the active seed.
- `POST /api/v1/checksum/verify` – Verify the checksum of the running script. - `POST /api/v1/checksum/verify` – Verify the checksum of the running script.
@@ -199,6 +199,10 @@ curl -H "Authorization: Bearer <token>" \
http://127.0.0.1:8000/api/v1/notifications http://127.0.0.1:8000/api/v1/notifications
``` ```
The TUI displays these alerts in a persistent notification box for 10 seconds,
but the endpoint returns all queued messages even if they have already
disappeared from the screen.
### Changing the Master Password ### Changing the Master Password
Update the vault password via `POST /api/v1/change-password`: Update the vault password via `POST /api/v1/change-password`:

4
requirements.lock
View File

@@ -1,6 +1,6 @@
aiohappyeyeballs==2.6.1 aiohappyeyeballs==2.6.1
aiohttp==3.12.13 aiohttp==3.12.14
aiosignal==1.3.2 aiosignal==1.4.0
attrs==25.3.0 attrs==25.3.0
argon2-cffi==23.1.0 argon2-cffi==23.1.0
base58==2.1.1 base58==2.1.1

2
src/requirements.txt
View File

@@ -5,7 +5,7 @@ bip-utils>=2.5.0
bech32==1.2.0 bech32==1.2.0
coincurve>=18.0.0 coincurve>=18.0.0
mnemonic mnemonic
aiohttp aiohttp>=3.12.14
bcrypt bcrypt
pytest>=7.0 pytest>=7.0
pytest-cov pytest-cov