Getting Started¶

This guide will help you set up Plex integration with plistsync from start to finish.

Prerequisites¶

Installation¶

First, install the Plex optional dependencies:

pip

pip install 'plistsync[plex]'

uv add plistsync --extra plex

Plex Account¶

You’ll need an active Plex account to use this application. If you don’t have one, sign up at plex.tv. Additionally, you must have a self-hosted Plex Media Server instance running, as some API endpoints are not available through the public Plex API and require direct server access.

Configuration¶

Enable Plex in your plistsync configuration file:

# ./config/config.yaml
services:
  plex:
    enabled: true
    server_url: your_plex_server_url_here
    server_name: optional_server_name

Authentication¶

Once configured, authenticate plistsync with your Plex account:

plistsync auth plex

This will start an interactive authentication flow:

You’ll be prompted to open a browser to Plex’s authorization page
Log in with your Plex credentials
Grant plistsync the requested permissions
This will save an authentication token in the config folder

Authentication Preview¶

Verification¶

Test that everything is working by getting your user data:

from plistsync.services.plex.api import PlexApi
print(PlexApi().identity())

This should return your machineIdentifier and some related metadata.