Implement MediaShelf v1
The application the design describes: Flask + SQLite, Plex for library data, Tautulli for watch history, report-only. Structure follows the design's seams. providers/ splits MediaProvider from HistoryProvider, because on this network library data and watch data live on different machines and Jellyfin later will have no Tautulli equivalent. scoring.py implements the reclaim score twice - as a SQL expression for the live grid (weights change on every slider drag, so storing it would mean rewriting thousands of rows per drag) and in Python for CSV export and tests, with a property test over 500 generated rows asserting the two agree. rules.py compiles saved views to parameterized SQL through a field/operator whitelist; nothing user-supplied is ever interpolated. Three properties are enforced by test rather than asserted in prose: - Ingest is idempotent. Three consecutive full scans leave every count and every byte total unchanged. A scanner that double-counts produces a report that looks plausible and is wrong. - Keep marks survive Plex reassigning every rating key in the library. They are keyed on content GUID, scoped per library so the Movies and 4K Movies copies of the same film mark independently. - Every config variable the app reads is declared in docker-compose.yml, so a variable set in Portainer can never silently do nothing. Also found and fixed while verifying against a fake Plex+Tautulli pair: executescript() commits the pending transaction, so migrations needed their BEGIN/COMMIT inside the script; replaceChildren() renders null as the literal text "null"; a hash-only URL change does not reload the document, so deep links needed a hashchange listener; and SQLite ROUND rounds half away from zero where Python rounds half to even. 73 tests, no live server required. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GVbG48GAXfCZatcmX123Ra
This commit is contained in:
parent
58c2883492
commit
6a557bcdd9
37 changed files with 6486 additions and 85 deletions
57
README.md
57
README.md
|
|
@ -12,15 +12,46 @@ candidates.
|
|||
|
||||
## Status
|
||||
|
||||
**v1 is report-only.** MediaShelf does not delete, move, or modify anything. It produces
|
||||
a ranked list, saved rule sets, and CSV export. Deletion is designed for in the roadmap
|
||||
but deliberately not built, so the scanner and the scoring model can be trusted before
|
||||
anything destructive is wired up.
|
||||
**v1 is report-only.** MediaShelf does not delete, move, or modify anything — not a file,
|
||||
not a Plex record. It produces a ranked list, saved rule sets, and CSV export. Deletion is
|
||||
designed for in the roadmap but deliberately not built, so the scanner and the scoring
|
||||
model can be trusted before anything destructive is wired up.
|
||||
|
||||
Nothing is implemented yet — this repository holds the design plus the read-only tools
|
||||
used to validate it. The design has been checked against the live servers: 65.7 TB across
|
||||
24 libraries, 2,930 movies and 2,807 TV seasons, 87,640 logged plays from 60 users, and
|
||||
27.4 TB never played. See `docs/design.md` §2.1.
|
||||
The application is implemented and tested; it has not yet been deployed. The design was
|
||||
validated against the live servers first: 65.7 TB across 24 libraries, 2,930 movies and
|
||||
2,807 TV seasons, 87,640 logged plays from 60 users, and 27.4 TB never played. See
|
||||
`docs/design.md` §2.1.
|
||||
|
||||
## Running it
|
||||
|
||||
```bash
|
||||
pip install -r requirements-dev.txt
|
||||
cp .env.example .env # fill in PLEX_TOKEN and TAUTULLI_API_KEY
|
||||
|
||||
python3 -m mediashelf.cli scan --full # first ingest
|
||||
python3 -m mediashelf.cli serve # http://127.0.0.1:8080
|
||||
make test # 73 tests, no live server needed
|
||||
```
|
||||
|
||||
Deployment is a single container behind Nginx Proxy Manager — see `docs/design.md` §11.
|
||||
Build off-box and push the image to Nox's Portainer; `docker-compose.yml` is the stack.
|
||||
|
||||
## Layout
|
||||
|
||||
```
|
||||
mediashelf/
|
||||
config.py every setting, read once from the environment
|
||||
db.py SQLite (WAL) + numbered SQL migrations
|
||||
providers/ Plex (library) and Tautulli (history) behind two protocols
|
||||
ingest.py scan orchestration, rollups, keep resolution
|
||||
scoring.py the reclaim score, in SQL and in Python
|
||||
rules.py saved-view grammar -> parameterized SQL, whitelist only
|
||||
keeps.py GUID-keyed keep marks
|
||||
queries.py the item query, live score, dashboard aggregates
|
||||
api.py / web.py JSON API and the page shell
|
||||
tools/ read-only probe, reclaim preview, fake Plex+Tautulli
|
||||
tests/ 73 tests, run entirely against the fake server
|
||||
```
|
||||
|
||||
## What it does
|
||||
|
||||
|
|
@ -42,10 +73,10 @@ used to validate it. The design has been checked against the live servers: 65.7
|
|||
GUIDs rather than rating keys, so they survive a library rebuild
|
||||
- CSV export of any view
|
||||
|
||||
## Planned stack
|
||||
## Stack
|
||||
|
||||
Python + Flask, SQLite (WAL), vanilla JS front-end, single container deployed as a
|
||||
Portainer stack behind Nginx Proxy Manager.
|
||||
Python + Flask, SQLite (WAL), vanilla JS front-end (no build step), single container
|
||||
deployed as a Portainer stack behind Nginx Proxy Manager.
|
||||
|
||||
## Roadmap
|
||||
|
||||
|
|
@ -53,9 +84,9 @@ Portainer stack behind Nginx Proxy Manager.
|
|||
allowlist, and an audit log
|
||||
- **v3** — Emby and Jellyfin support behind the existing `MediaProvider` abstraction
|
||||
|
||||
## Validating the design first
|
||||
## Read-only LAN tools
|
||||
|
||||
Plex and Tautulli are both LAN-only, so `tools/probe.py` exists to check this design
|
||||
Plex and Tautulli are both LAN-only, so these exist to check the design and the numbers
|
||||
against real data from inside the network. It is **read-only** — GET requests only,
|
||||
nothing is modified — and has no dependencies beyond the standard library.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue