plex-music-rating-sync

Plex Agents do not read music ratings when importing music files. This makes sense from a server-side-of-view. You don't want all users to have the same ratings or playlists. Every user should be able to set his / her own ratings and collect his favorite songs in playlists.

This project aims to provide a simple sync tool that synchronizes the track ratings and playlists with a specific PLEX user account and server.

Features

synchronize: track ratings, playlists (not automatically generated)
supported local media players: MediaMonkey
dry run without applying any changes
automatically or manually resolve conflicting track ratings
logging

Requirements

Windows
MediaMonkey v4.0 or higher
Plex Media Server (PMS)
Python 3.6 or higher with packages:
- PlexAPI v4.2.0
- pypiwin32: to use the COM interface
- fuzzywuzzy: for fuzzy string matching
- python-Levenshtein (optional): to improve performance of fuzzywuzzy
- numpy
- ConfigArgParse
- pandas

Installation

Clone this repository git clone git@github.com:patzm/plex-music-rating-sync.git
cd plex-music-rating-sync
Install all requirements pip3.6 install -r requirements.txt

How to run

The main file is sync_ratings.py. Usage description: Note: default values of command line arguments can be provided by editing config.ini

usage: sync_ratings.py [-h] [--dry] [--reverse] [--log LOG] [--passwd PASSWD] [--token TOKEN]
                       [--sync ITEM] [--player PLAYER] --server SERVER --username USERNAME

Synchronizes ID3 music ratings with a Plex media-server

required arguments:
  --server SERVER      The name of the plex media server
  --username USERNAME  The plex username
  
optional arguments:
  -h, --help           show this help message and exit
  --dry                Does not apply any changes
  --reverse            Reverses ratings synchronization from Plex to local player 
  --sync               Selects which items to sync: one or more of: tracks, playlists [default is tracks]
  --log LOG            Sets the logging level
  --passwd PASSWD      The password for the plex user. NOT RECOMMENDED TO USE!
  --token TOKEN        Plex API token.  See https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/ for information on how to find your token
  --player PLAYER      Media player to synchronize with Plex [default is MediaMonkey]

Start the synchronization: ./sync_ratings.py --server <server_name> --username <my@email.com|user_name> Using the --dry flag in combination with --log DEBUG is recommended to see what changes will be made.

Current issues

the PlexAPI seems to be only working for the administrator of the PMS.
playlist synchronization from Plex to local player not implemented

Potential next features

With the current state I have completed all functionality I desired to have. Consequently I will not continue development unless you request it. I welcome anyone to join the development of this little cmd-line tool. Just open a new issue, post a pull request, or ask me to give you permissions for the repository itself.

These are a few ideas I have for features that would make sense:

setup routine
bi-directional sync
parallelization
better user-interaction with nicer dialogs
iTunes synchronization?

References

PlexAPI simplifies talking to a PMS.

This project uses the MediaMonkey scripting interface using Microsoft COM model. An introduction can be found here. The relevant model documentation is available here.

cperreault/plex-music-rating-sync