_mod_PLEX

Sync engine module for Plex (watchlist/history/ratings indexing and writes).

Provider ID: PLEX Version (module): 3.2.0

Plex support in the sync engine.

Use it to sync:

watchlist
history
ratings
progress

Setup docs:

Entry point: sync/_mod_PLEX.py

Provider surface

health()
build_index(feature)
add(feature, items)
remove(feature, items)

Features

watchlist → providers/plex/_watchlist.py
history → providers/plex/_history.py
ratings → providers/plex/_ratings.py
progress → providers/plex/_progress.py

Capabilities

bidirectional: true
provides_ids: true
index_semantics: "present"

Config

Config block name:

Plex or plex

Common keys:

token
baseurl (optional; needed for some setups)
timeout (default 10.0), max_retries (default 3)
watchlist_allow_pms_fallback (default true)
watchlist_page_size (default 100)

Gotchas

Watchlist writes may prefer Plex Discover.

Allow PMS fallback only if you need it.

Runtime call flow

Orchestrator
  └─ OPS.build_index(cfg, feature)
       └─ PLEXModule.build_index(feature)
            └─ providers/plex/_{feature}.py : build_index(adapter, ...)

Writes are symmetric:

Orchestrator plan → OPS.add/remove(...)
  └─ PLEXModule.add/remove(feature, items, dry_run=...)
       └─ providers/plex/_{feature}.py : add/remove(adapter, items)

OPS contract

name()
label()
features()
capabilities()
is_configured(cfg)
build_index(cfg, feature=...)
add(cfg, items, feature=..., dry_run=False)
remove(cfg, items, feature=..., dry_run=False)
health(cfg)

Full config reference

Config namespace:

cfg["plex"] (fallback: cfg["auth"]["plex"])

Fields:

token, baseurl, client_id
server_name, machine_id
username, account_id, home_pin, password
timeout (default: 10.0)
max_retries (default: 3)
watchlist_allow_pms_fallback (default: true)
watchlist_page_size (default: 100)

Dependencies:

requires: ['plexapi']

Previoushistory Nextoverview

Last updated 3 months ago

Was this helpful?