tl/README.md
Your Name 36054ac329 Attribute annotations and scene saves to users
Server-authoritative attribution: on each scene PUT the server diffs incoming
annotation groups and stamps createdBy/editedBy (+ timestamps) from request.user,
ignoring client-sent stamps so authorship can't be forged. Each save also writes
a Revision (user, time, +N ~N −N summary, snapshot of the annotation layer),
visible in the admin and via /revisions/. Projects gain collaborators so several
users can edit one project and get distinct attribution.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-29 00:12:13 -04:00

48 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# scene_analysis
- `tl/` — the lumet frontend (ClojureScript / reagent / re-frame). See `tl/`.
- Django backend (this folder) — users, admin, and persistence of OTIO + the
timeline scene.
## Backend
The backend stores one `Project` per editing session: the uploaded **OTIO**
source file, the playback **fps**, and the live **scene** (the `{:tracks
:groups}` mark-group map the frontend keeps in app-db) as a JSON dump.
### Run
```bash
python -m venv .venv && .venv/bin/pip install -r requirements.txt
.venv/bin/python manage.py migrate
DJANGO_SUPERUSER_PASSWORD=admin .venv/bin/python manage.py createsuperuser --noinput --username admin --email admin@example.com
.venv/bin/python manage.py seed_demo # demo project from tl/.../one_two_three.otio
.venv/bin/python manage.py runserver
```
Admin: <http://127.0.0.1:8000/admin/> (admin / admin). Upload OTIO and inspect
the scene JSON there.
### API (session auth; 401 if not logged in)
| Method | Path | Purpose |
| --- | --- | --- |
| GET | `/api/projects/` | the current user's projects |
| GET | `/api/projects/<id>/scene/` | `{fps, scene}` |
| PUT | `/api/projects/<id>/scene/` | replace `scene` and/or `fps` (JSON body) |
| GET | `/api/projects/<id>/otio/` | serve the uploaded OTIO file |
| GET | `/api/projects/<id>/revisions/` | save history (who / when / summary) |
### Attribution
Annotations are the authored unit, so that's what's attributed — and the server
is the authority (client-sent stamps are ignored, so authorship can't be
forged). On each scene `PUT` the server diffs incoming annotation groups against
the stored ones and stamps `createdBy`/`editedBy` (+ timestamps) from
`request.user`; it also writes a `Revision` (user, time, `+N ~N −N` summary,
snapshot of the annotation layer). A project is editable by its `owner` and any
`collaborators` (managed in the admin), so different users get distinct stamps.
The frontend currently loads `/one_two_three.otio` and persists annotations to
localStorage; pointing it at `/api/projects/<id>/otio/` and the scene endpoints
is the next wiring step (CORS/credentials needed across the dev ports).