_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
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.pyhistory→providers/plex/_history.pyratings→providers/plex/_ratings.py
Capabilities
bidirectional: trueprovides_ids: trueindex_semantics: "present"
Config
Config block name:
Plexorplex
Common keys:
tokenbaseurl(optional; needed for some setups)timeout(default10.0),max_retries(default3)watchlist_allow_pms_fallback(defaulttrue)watchlist_page_size(default100)
Gotchas
Watchlist writes may prefer Plex Discover.
Allow PMS fallback only if you need it.
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_idserver_name,machine_idusername,account_id,home_pin,passwordtimeout(default:10.0)max_retries(default:3)watchlist_allow_pms_fallback(default:true)watchlist_page_size(default:100)
Dependencies:
requires: ['plexapi']
Last updated
Was this helpful?