Skip to content

DEV_NOTES.md

Latest commit

 

History

History
52 lines (44 loc) · 2.74 KB

DEV_NOTES.md

File metadata and controls

52 lines (44 loc) · 2.74 KB
Raw

Dev Notes – mam-audiofinder

Recent Key Changes Implemented

  • Added a Settings helper in app/main.py:
    • Loads config from /data/config.json (or APP_CONFIG_PATH) and falls back to env vars.
    • Centralizes: MAM_COOKIE, QB_URL, QB_USER, QB_PASS, DL_DIR, LIB_DIR, IMPORT_MODE, QB_INNER_DL_PREFIX, QB_PATH_MAP, etc.
  • Introduced explicit qB → app path mapping:
    • settings.QB_PATH_MAP is a list of (qb_prefix, app_prefix) pairs.
    • Populated from:
      • JSON config key QB_PATH_MAP (list of objects with qb_prefix / app_prefix), or
      • Env QB_PATH_MAP="qb=/path;qb2=/path2", or
      • Fallback: QB_INNER_DL_PREFIX → DL_DIR.
    • do_import now uses this mapping in map_qb_path, with legacy Unraid heuristics left as secondary fallbacks.
  • Added a first‑run setup wizard:
    • GET / serves setup.html if needs_setup() (no cookie, no lib dir, or no path map) and setup is not disabled via env.
    • GET /setup shows the wizard unless DISABLE_SETUP is set (then it returns 404).
    • POST /api/setup writes /data/config.json and calls settings.reload().
    • UI files: app/templates/setup.html, app/static/setup.js.
  • Setup UX tweaks:
    • Main page includes a “Setup / Configuration” button (hidden when DISABLE_SETUP is enabled).
    • The setup page title links back to /.
  • Root‑level AGENTS.md documents repo conventions and agent guidance.

How to Run for Testing

  • Local dev (no Docker), from app/:
    • uvicorn main:app --reload --host 0.0.0.0 --port 8080
    • Optionally set APP_CONFIG_PATH=../dev-config.json to avoid writing into /data.
  • Docker (on Unraid or similar):
    • Update .env for mounts and ports, then docker compose up -d.
    • First visit to / on a fresh data directory should trigger the setup wizard (unless DISABLE_SETUP is set).

Release Notes / Checklist (GHCR)

  • Build and tag image from repo root:
    • docker build -t ghcr.io/raygan/mam-audiofinder:0.6 -t ghcr.io/raygan/mam-audiofinder:latest .
  • Login to GHCR (once per machine):
    • echo "$GHCR_PAT" | docker login ghcr.io -u raygan --password-stdin
  • Push tags:
    • docker push ghcr.io/raygan/mam-audiofinder:0.6
    • docker push ghcr.io/raygan/mam-audiofinder:latest
  • Consumers update via:
    • docker compose pull && docker compose up -d

Possible Next Steps

  • Add a “Test qB connection” button on the setup page (hit /api/v2/app/version).
  • Improve error messages when map_qb_path cannot resolve a path.
  • Add a minimal pytest suite that mocks MAM/qB and exercises /health, /search, /add, /qb/torrents, and /import using a temp /data directory.
  • Investigate adding real time download status for recently added torrents
  • Investigate displaying artwork. Available via MAM API?