diff --git a/README.md b/README.md index 65a8234..e777d06 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ - Perplex - \ No newline at end of file +# Perplex + +A Movie Renamer for Plex Metadata + +## Overview + +This simple Python script for renaming movie files in a Plex database. +[Plex](http://plex.tv/) is a software suite for organizing videos, +music and photos. It can identify movies based on their file names +and retrieve corresponding metadata. In practice, however, not all +file names are appropriate and thus some movies usually need to be +assigned to the corresponding movie titles manually. Unfortunately, +Plex is not able to rename these files and thus if the database is +initialized from the scratch these files need to be manually fixed +again. + +The Python script `perplex` solves this problem. Given an +installation of Plex and the corresponding database, it lists all +imported movies and renames them according to the retrieved movie +metadata. To avoid breaking the current installation, the renamed +files are copied to another directory. + +That's it. diff --git a/perplex.py b/perplex.py index 852795e..c82bfd6 100755 --- a/perplex.py +++ b/perplex.py @@ -1,5 +1,5 @@ #!/usr/bin/env python -# Perplex - Plex-base Movie Renamer +# Perplex - A Movie Renamer for Plex Metadata # Copyright (c) 2015 Konrad Rieck (konrad@mlsec.org) import argparse