search

dakusan / PlexPlaylistImporter

Import playlists into Plex
Other
81 stars 18 forks source link

readme

Plex Playlist Importer - v1.1.0.x http://www.castledragmire.com/Projects/Plex_Playlist_Importer

Import playlists into Plex

My music directories have been growing for over 2 decades in a folder based hierarchy, often using playlists for organization. Plex’s music organization is counterintuitive to this organizational structure, and Plex currently does not have an easy way to import external playlists. Hence this script was born :-)

You can run this by directly dragging playlists onto it.
This script is fully unicode compliant.

Running and Troubleshooting

Parameters:

usage:
PlexPlaylistImporter.py [-h] [-p Given_DB_Path] [-e Playlist_Encoding] [-t File_Type_Override] [-f] Playlist_Path Plex_Playlist_Name

positional arguments:

ArgumentsExplanation
Playlist_PathThe path of the playlist file
Plex_Playlist_Name The name of the playlist in Plex to import to.
  • If not given, the program will prompt for it.
  • If the given playlist does not already exist, the program will prompt on whether to create it (unless -f is specified).

optional arguments:

ArgumentsExplanation
-h OR --help
 show this help message and exit 
-p OR --sqlitedb-path
Given_DB_Path		The path to the sqlite3 database file
  • The program tries to guess the path for the Plex data directory. If it cannot be found, this path needs to be passed explicitly
    • The default paths are:
      • Windows:
        • %LOCALAPPDATA%/Plex Media Server/
        • C:/Users/%USER%/AppData/Local/Plex Media Server/
      • Linux:
        • %PLEX_HOME%/Library/Application Support/Plex Media Server/
  • If the database is still not found from the given Plex path, the full path to the database is required
    • Defaults: (%PLEX_PATH% is from the path found from above)
      • %PLEX_PATH%/Plug-in Support/Databases/com.plexapp.plugins.library.db
      • %PLEX_PATH%/Plug-Ins/Databases/com.plexapp.plugins.library.db
    • Note: When passing a parameter string, environmental variables are not processed
 
-e OR --playlist_encoding
Playlist_Encoding		 The encoding the playlist file is in. This is generally “utf-8”, but may also likely be “ISO-8859-1”. Default=utf-8 
-t OR --override-type
File_Type_Override		 The file type to encode as. If the file extension is not recognized, the file is parsed as a Winamp playlist (m3u). This allows overriding the determined file type. Default=NONE 
-f OR --force-list
 Do not prompt to create the playlist if it does not already exist.

The only playlist type that is currently supported is Winamp playlists (.m3u).
Playlist importers just collect the absolute files names, and others can easily be dropped into the “Importers” directory without any other code changes.
While the M3U importer (Importers/M3U.py) is the most appropriate to use as a template, I included a second example one (PTL.py) which just pulls in absolute file names with no error checks.

PlexPlaylistImporter.sh is just included to force proper Unicode (utf-8) encoding and column widths on the console.

How it works

The songs you want to play have to already exist in the Plex database.
When you add a song to Plex (through Plex), it stores the song’s full file path in the Plex database. What this script does is derive all the full song paths in a playlist file that you give it, checks those paths against Plex’s database, and then adds the matches in the proper order into the Plex playlist you specified.
So for this reason, the script must be ran on the same computer running the Plex server so that it can match the paths. (There are, of course, workarounds to this. However, I highly recommend against it, as I have found that doing this may corrupt the Plex server database).

Creating the executable

python setup.py py2exe

Copyright and coded by Dakusan - See http://www.castledragmire.com/Copyright for more information.