Skip to content

A python script that syncs the movies, shows and ratings between trakt and Plex (without needing a PlexPass or Trakt VIP subscription)

License

Notifications You must be signed in to change notification settings

mcdallas/PlexTraktSync

 
 

Repository files navigation

Plex-Trakt-Sync

Python Versions

This project adds a two-way-sync between trakt.tv and Plex Media Server. It requires a trakt.tv account but no Plex premium and no Trakt VIP subscriptions, unlike the Plex app provided by Trakt.

To contribute, please find issues with the help-wanted label, thank you.

Features

  • Media in Plex are added to Trakt collection
  • Ratings are synced (if ratings differ, Trakt takes precedence)
  • Watched status are synced (dates are not reported from Trakt to Plex)
  • Liked lists in Trakt are downloaded and all movies in Plex belonging to that list are added
  • You can edit the config file to choose what to sync
  • None of the above requires a Plex Pass or Trakt VIP membership. Downside: Needs to be executed manually or via cronjob, can not use live data via webhooks.

Pre-requisites

The script is known to work with Python 3.7-3.9 versions.

Installing

To install this project, find out the latest release:

Download the .tar, or .zip or checkout the release with Git.

For example, the command to clone with Git:

git clone -b 0.7.19 --depth=1 https://github.com/Taxel/PlexTraktSync

In the extracted directory, install the required Python packages:

python3 -m pip install -r requirements.txt

Alternatively you can use pipenv:

python3 -m pip install pipenv
pipenv install
pipenv run plex-trakt-sync

Setup

To connect to Trakt you need to create a new API app:

  • Visit https://trakt.tv/oauth/applications/new
  • Give it a meaningful name
  • Enter urn:ietf:wg:oauth:2.0:oob as the redirect url
  • You can leave Javascript origins and the Permissions checkboxes blank

Then, run python3 -m plex_trakt_sync.

At first run, you will be asked to setup Trakt and Plex access. Follow the instructions, your credentials and API keys will be stored in .env and .pytrakt.json files.

If you have 2 Factor Authentication enabled on Plex, you can append the code to your password.

You can take a look at the progress in the last_update.log file which will be created.

To set up to run this script in a cronjob every two hours, type crontab -e in the terminal.

0 */2 * * * cd ~/path/to/this/repo && python3 -m plex_trakt_sync

Sync options

The sync subcommand supports --sync=tv and --sync=movies options, so you can sync only specific library types.

➔ python3 -m plex_trakt_sync sync --help
Usage: plex_trakt_sync sync [OPTIONS]

  Perform sync between Plex and Trakt

Options:
  --sync [all|movies|tv]  Specify what to sync  [default: all]
  --help                  Show this message and exit.

Sync settings

To disable parts of the functionality of this software, look no further than config.json. Here, in the sync section, you can disable the following things by setting them from true to false in a text editor:

At first run, the script will create config.json based on config.default.json. If you want to customize settings before first run (ex. you don't want full sync) you can copy and edit config.json before launching the script.

  • Downloading liked lists from Trakt and adding them to Plex
  • Downloading your watchlist from Trakt and adding it to Plex
  • Syncing the watched status between Plex and Trakt
  • Syncing the collected status between Plex and Trakt

The unmatched command

You can use unmatched command to scan your library and display unmatched movies.

Support for unmatched shows is not yet implemented.

The watch command

You can use watch command to listen to events from Plex Media Server and scrobble plays.

What is scrobbling?

Scrobbling simply means automatically tracking what you’re watching. Instead of checking in from your phone of the website, this command runs in the background and automatically scrobbles back to Trakt while you enjoy watching your media - Plex [email protected]

$ python3 -m plex_trakt_sync watch

NOTE: The watch command will scrobble all Plex Watches to Trakt as filtering by user is not implemented #324.

Notes

  • The first execution of the script will (depending on your PMS library size) take a long time. After that, movie details and Trakt lists are cached, so it should run a lot quicker the second time. This does mean, however, that Trakt lists are not updated dynamically (which is fine for lists like "2018 Academy Award Nominees" but might not be ideal for lists that are updated often). Here are the execution times on my Plex server: First run - 1228 seconds, second run - 111 seconds

  • The PyTrakt API keys are not stored securely, so if you do not want to have a file containing those on your harddrive, you can not use this project.

About

A python script that syncs the movies, shows and ratings between trakt and Plex (without needing a PlexPass or Trakt VIP subscription)

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • Python 99.2%
  • Other 0.8%