Rewrite Curator in Rust with an egui GUI
This commit is contained in:
+35
-32
@@ -1,41 +1,44 @@
|
||||
# Curator documentation
|
||||
|
||||
Curator is a PySide6 desktop application that manages a Jellyfin-first movie and
|
||||
series pool: it imports files, identifies them through TMDb, groups multiple
|
||||
versions of a film, keeps series in Jellyfin's layout and generates a miniDLNA /
|
||||
Filmotéka tree.
|
||||
Curator is a Rust desktop application (egui) that manages a Jellyfin-first movie
|
||||
and series pool: it imports files, identifies them through TMDb, groups multiple
|
||||
versions of a film, keeps series in Jellyfin's layout and generates a miniDLNA
|
||||
tree of hardlinks.
|
||||
|
||||
- [Architecture](architecture.md) — layers, on-disk layout, the pool index and the
|
||||
rules about versions, series and subtitles. Read this first.
|
||||
- [Module reference](#module-reference) — one document per source module, with a
|
||||
description of the module and of every class and function.
|
||||
- **API reference** — every public type and function is documented in the source;
|
||||
`cargo doc --open` renders it.
|
||||
|
||||
## Module reference
|
||||
## Module overview
|
||||
|
||||
| Source | Purpose |
|
||||
|--------|---------|
|
||||
| [`Curator.py`](modules/entry-point.md) | Application entry point. |
|
||||
| [`src/_version.py`](modules/_version.md) | Auto-generated — do not edit manually. |
|
||||
| [`src/constants.py`](modules/constants.md) | Application-level constants for Curator (build/runtime metadata). |
|
||||
| [`src/core/config.py`](modules/core.config.md) | Configuration for Curator. |
|
||||
| [`src/core/csfd.py`](modules/core.csfd.md) | ČSFD.cz scraper — a *title bridge* to TMDb. |
|
||||
| [`src/core/file.py`](modules/core.file.md) | The `File` class: one playable movie file as the UI sees it. |
|
||||
| [`src/core/file_manager.py`](modules/core.file_manager.md) | `FileManager`: the application's service layer. |
|
||||
| [`src/core/hardlink_manager.py`](modules/core.hardlink_manager.md) | Hardlink Manager for Curator |
|
||||
| [`src/core/integrity.py`](modules/core.integrity.md) | Video integrity checking via FFmpeg. |
|
||||
| [`src/core/jellyfin.py`](modules/core.jellyfin.md) | Jellyfin server API client — thin, hybrid integration. |
|
||||
| [`src/core/legacy_meta.py`](modules/core.legacy_meta.md) | Readers for Curator's *pre-index* metadata layouts. |
|
||||
| [`src/core/list_manager.py`](modules/core.list_manager.md) | Sorting of file lists by name or by date added. |
|
||||
| [`src/core/migrate.py`](modules/core.migrate.md) | One-off migration of an existing pool to the Jellyfin naming convention. |
|
||||
| [`src/core/movie.py`](modules/core.movie.md) | The movie object — metadata first, files second. |
|
||||
| [`src/core/naming.py`](modules/core.naming.md) | Pool file naming convention. |
|
||||
| [`src/core/nfo.py`](modules/core.nfo.md) | NFO reader — Curator's metadata source after ČSFD. |
|
||||
| [`src/core/pool_index.py`](modules/core.pool_index.md) | Unified metadata index for the Curator pool. |
|
||||
| [`src/core/series.py`](modules/core.series.md) | Series naming + scanning for the Jellyfin TV layout. |
|
||||
| [`src/core/subtitles.py`](modules/core.subtitles.md) | External subtitle sidecars — attach, discover, keep in sync on rename. |
|
||||
| [`src/core/tag.py`](modules/core.tag.md) | The `Tag` value object: a `(category, name)` pair identified by its `full_path` (`Category/Name`). |
|
||||
| [`src/core/tag_manager.py`](modules/core.tag_manager.md) | `TagManager`: the registry of all tag categories and their tags. |
|
||||
| [`src/core/tmdb.py`](modules/core.tmdb.md) | TMDb (The Movie Database) client — Curator's identity source. |
|
||||
| [`src/core/transforms.py`](modules/core.transforms.md) | Tag-schema value transforms for miniDLNA folder names. |
|
||||
| [`src/core/utils.py`](modules/core.utils.md) | Small filesystem helpers shared across the core modules. |
|
||||
| [`src/ui/qt_app.py`](modules/ui.qt_app.md) | PySide6 GUI for Curator — reframed around the Filmotéka (movie-library) workflow. |
|
||||
| [`src/main.rs`](../src/main.rs) | Entry point: `.env`, logging, opens the window. |
|
||||
| [`src/bin/tipy-dne.rs`](../src/bin/tipy-dne.rs) | Standalone "Tipy dne" generator for a systemd timer. |
|
||||
| [`src/constants.rs`](../src/constants.rs) | App name, version (from `Cargo.toml`), debug flag, window title. |
|
||||
| [`src/core/config.rs`](../src/core/config.rs) | Global config (window, pool and output paths) and the default tag schema. |
|
||||
| [`src/core/error.rs`](../src/core/error.rs) | `CoreError`, the error type of every core operation. |
|
||||
| [`src/core/paths.rs`](../src/core/paths.rs) | `pathlib`-style helpers: suffix/stem, POSIX-relative paths, recursive walk, moves. |
|
||||
| [`src/core/naming.rs`](../src/core/naming.rs) | The `Title (YYYY) [tmdbid-N].3D.FMT` naming convention: build, parse, guess from filenames. |
|
||||
| [`src/core/movie.rs`](../src/core/movie.rs) | The movie record (`Movie`, `MediaFile`), identity keys, version/part labels. |
|
||||
| [`src/core/file.rs`](../src/core/file.rs) | `File`: one pooled video, a view on one media entry of a movie record. |
|
||||
| [`src/core/pool_index.rs`](../src/core/pool_index.rs) | `PoolIndex`: the `.Curator.!index` JSON store (v1 → v2 migration). |
|
||||
| [`src/core/series.rs`](../src/core/series.rs) | Series naming (`SxxEyy`, `Season NN`, `.ptN`) and scanning. |
|
||||
| [`src/core/subtitles.rs`](../src/core/subtitles.rs) | Subtitle sidecars: find, attach, follow their video on rename. |
|
||||
| [`src/core/tag.rs`](../src/core/tag.rs), [`tag_manager.rs`](../src/core/tag_manager.rs) | Tags (`Category/Name`) and the registry of known tags. |
|
||||
| [`src/core/transforms.rs`](../src/core/transforms.rs) | Folder-name transforms (rating → ten-point band). |
|
||||
| [`src/core/nfo.rs`](../src/core/nfo.rs) | Read-only NFO reader (genres, year, countries, rating, ids). |
|
||||
| [`src/core/legacy_meta.rs`](../src/core/legacy_meta.rs) | Recovery of ČSFD link / title / year from pre-index layouts. |
|
||||
| [`src/core/tmdb.rs`](../src/core/tmdb.rs) | TMDb client: lookups, searches, details for tags. |
|
||||
| [`src/core/csfd.rs`](../src/core/csfd.rs) | ČSFD scraper with the Anubis proof-of-work solver — the title bridge to TMDb. |
|
||||
| [`src/core/jellyfin.rs`](../src/core/jellyfin.rs) | Jellyfin client: library scan, read back movies. |
|
||||
| [`src/core/http.rs`](../src/core/http.rs) | Shared blocking HTTP client (OS certificate store). |
|
||||
| [`src/core/integrity.rs`](../src/core/integrity.rs) | Video integrity check via ffmpeg / ffprobe. |
|
||||
| [`src/core/migrate.rs`](../src/core/migrate.rs) | Classification of TMDb match proposals for an old pool. |
|
||||
| [`src/core/hardlink_manager.rs`](../src/core/hardlink_manager.rs) | The miniDLNA hardlink tree, mirrors, special folders, obsolete-link sweep. |
|
||||
| [`src/core/file_manager/`](../src/core/file_manager/) | `FileManager`, the service layer: libraries and settings (`mod.rs`), movies (`movies.rs`), versions and parts (`versions.rs`), series (`series_ops.rs`), tools (`tools.rs`), miniDLNA generation (`minidlna.rs`). |
|
||||
| [`src/ui/app.rs`](../src/ui/app.rs) | The main window: menu, tag filter, table, detail panel, status bar, actions. |
|
||||
| [`src/ui/dialogs/`](../src/ui/dialogs/) | One file per dialog (import, edit, series, duplicates, libraries, migration, tags, schema, stats). |
|
||||
| [`src/ui/common.rs`](../src/ui/common.rs), [`task.rs`](../src/ui/task.rs) | Message boxes, prompts, background jobs and tasks with progress. |
|
||||
| [`examples/screenshot.rs`](../examples/screenshot.rs) | Developer tool: render the window offscreen to a PNG. |
|
||||
|
||||
Reference in New Issue
Block a user