TV Renamr is a utility to rename TV shows based upon filenames or user input.
- Python 2.6+
- PyYaml
- The Interwebs
Make sure you have the python setuptools package installed for your version of python (check with python --version).
To install from the Python Package Index: easy_install tvrenamr - You may need to be an administrator to run this.
A nice shiny tvr script is now installed in the relevant directory.
Due to a problem with easy_install and Tv Renamr's option parsing code it isn't possible to use easy_install for installation just yet, but it should be fixed in the near future.
git clone git://github.com/ghickman/tvrenamr.git
cd tvrenamr
python setup.py install - You may need to be an administrator to run this.
Run in your terminal of choice: tvr [options] file/folder
For ease of use Tv Renamr uses a config file. By default it looks for it in ~/.tvrenamr/config.yml, an example one is available here which shows all the possible default values you can use.
The defaults segment should be self-explanatory but I'll list them just for completeness. The listed values are the assumed defaults if any of the options are not added.
format: '%n - %s%e - %t%x'
The output format you want your files to be renamed to.
library: thetvdb
The online database to use for your episode names. Options are: thetvdb or tvrage
organise: yes
Organise your files within the renamed directory.
renamed: /Volumes/Media/TV/
The target directory to move your renamed files to.
the: true
If a show has a leading 'The', such as 'The Big Bang Theory', move it to the end of the show name: 'Big Bang Theory, The'.
Below the defaults are shows that won't get renamed correctly using the default options. Taking CSI as the example you have:
csi:
canonical: "CSI: Crime Scene Investigation"
output: "CSI, Crime Scene Investigation"
csi is the torrent name and needs to match whatever name your file is being downloaded with, which for CSI would be csi.s10e01.blah.blah.avi.
canonical is name that the online database holds for the show.
output is what you want the show to be renamed to.
This method is the easiest way to deal with shows with a year in the name too, i.e. Castle (2009).
Note: The quotes around the canonical and output names for CSI are needed because of the colon and comma characters as they are reserved by YAML.
If you need more control or if theres a pesky file you need to test, then the command line options give you the most power.
-c or --canonical - Set the show's canonical name to use when performing the online lookup.
--deluge - Checks Deluge to make sure the file has been completed before renaming.
--deluge-ratio - Checks Deluge for completed and that the file has at least reached X share ratio.
-d or --dry-run - Dry run your renaming.
-e or --episode - Set the episode number. Currently this will cause errors when working with more than one file.
--log-file - Set the log file location.
-l or --log-level - Set the log level. Options: short, minimal, info and debug.
--library - Set the library to use for retrieving episode titles. Options: thetvdb & tvrage.
-n or --name - Set the show's name. This will be used as the show's when the renaming is completed.
-o or --output - Set the output format for the episodes being renamed.
--organise - Organise renamed files into folders based on their show name and season number.
--no-organise - Explicitly tell Tv Renamr not to organise renamed files. Used to override the config.
-q or --quiet - Don't output logs to the command line.
-r or --recursive - Recursively lookup files in a given directory.
--rename-dir - The directory to move renamed files to, if not specified the working directory is used.
--no-rename-dir - Explicitly tell Tv Renamr not to move renamed files. Used to override the config.
--regex - The regular expression to use when extracting information from files.
-s or --season - Set the season number.
-t or --the - Set the position of 'The' in a show's name to the end of the file.
tvrtvr /path/to/a/directory/tvr /path/to/a/file.avitvr --organise -r '/path/to/a/directory/' /path/to/a/directory/[a_file.avi]tvr --season '1' --name 'chuck' /path/to/a/file/the_file.avi
The logging level for the log file is always debug, however the amount of information you see in your console can be modified. Use the --log-level or -l options to select either short, minimal, info or debug.
Given the filename chuck.S01E02.avi to rename the log levels would show the following information:
Renamed: "Chuck - 102 - Chuck Versus the Helicopter.avi"
Renaming: chuck.S01E02.avi
Directory: /Volumes/Media/TV/Chuck/Season 1/
Renamed: "Chuck - 102 - Chuck Versus the Helicopter.avi"
Renaming: chuck.S01E02.avi
Searching: chuck
Episode: Chuck Versus the Helicopter
Directory: /Volumes/Media/TV/Chuck/Season 1/
Renamed: "Chuck - 102 - Chuck Versus the Helicopter.avi"
2010-10-17 20:40 DEBUG Config Config loaded
2010-10-17 20:40 DEBUG Config Defaults retrieved
2010-10-17 20:40 SHORT Core Dry Run beginning.
2010-10-17 20:40 SHORT Core ----------------------------------------------------------------------
2010-10-17 20:40 SHORT Core
2010-10-17 20:40 MINIMAL Core Renaming: chuck.S01E02.avi
2010-10-17 20:40 DEBUG Core Renaming using: (?P<show>[\w\s.,_-]+)\.[Ss]?(?P<season>[\d]{1,2})[XxEe]?(?P<episode>[\d]{2})
2010-10-17 20:40 DEBUG Core Returned show: chuck, season: 01, episode: 02, extension: .avi
2010-10-17 20:40 DEBUG Core Imported The Tv Db library
2010-10-17 20:40 INFO The Tv DB Searching: chuck
2010-10-17 20:40 DEBUG The Tv DB Retrieving series id for chuck
2010-10-17 20:40 DEBUG The Tv DB Series url: http://www.thetvdb.com/api/GetSeries.php?seriesname=chuck
2010-10-17 20:40 DEBUG The Tv DB XML: Attempting to parse
2010-10-17 20:40 DEBUG The Tv DB XML retrieved, searching for series
2010-10-17 20:40 DEBUG The Tv DB Series chosen: Chuck
2010-10-17 20:40 DEBUG The Tv DB Retrieved show id: 80348
2010-10-17 20:40 DEBUG The Tv DB Retrieved canonical show name: Chuck
2010-10-17 20:40 DEBUG The Tv DB Episode URL: http://www.thetvdb.com/api/C4C424B4E9137AFD/series/80348/default/1/2/en.xml
2010-10-17 20:40 DEBUG The Tv DB Attempting to retrieve episode name
2010-10-17 20:40 DEBUG The Tv DB XML: Retreived
2010-10-17 20:40 DEBUG The Tv DB XML: Attempting to parse
2010-10-17 20:40 DEBUG The Tv DB XML: Parsed
2010-10-17 20:40 DEBUG The Tv DB XML: Episode document retrived for Chuck - 0102
2010-10-17 20:40 DEBUG The Tv DB XML: Attempting to finding the episode name
2010-10-17 20:40 DEBUG The Tv DB Retrieved episode name: Chuck Versus the Helicopter
2010-10-17 20:40 INFO Core Episode: Chuck Versus the Helicopter
2010-10-17 20:40 DEBUG Error 'chuck' is not in the Config. Falling back on name extracted from the filename
2010-10-17 20:40 DEBUG Core Using the formatted show name retrieved by the library: Chuck
2010-10-17 20:40 DEBUG Core Final show name: Chuck
2010-10-17 20:40 MINIMAL Core Directory: /Volumes/Media/TV/Chuck/Season 1/
2010-10-17 20:40 DEBUG Core Full path: /Volumes/Media/TV/Chuck/Season 1/Chuck - 102 - Chuck Versus the Helicopter.avi
2010-10-17 20:40 MINIMAL Core Renamed: "Chuck - 102 - Chuck Versus the Helicopter.avi"
2010-10-17 20:40 SHORT Core
2010-10-17 20:40 SHORT Core ----------------------------------------------------------------------
2010-10-17 20:40 SHORT Core Dry Run complete. No files were harmed in the process.
2010-10-17 20:40 SHORT Core
Debug will automatically perform a dry run rename since it was designed to be used for testing. However this is the format you will see in your log file, minus the dry run lines of course.
By default TV Renamr will match shows in the formats: show.s0e00 and show.0x00 but you can specify custom regular expressions if your files aren't in either of these formats. Some custom regular expression syntax has been used to help you specify different parts of the filename:
- Show:
%n-(?P<show>[\w\s.,_-]+) - Season:
%s-(?P<season>[\d]{1,2}) - Episode:
%e-(?P<episode>[\d]{2})
It is also possible to specify how many digits there are in the season and episode sections of the filename using the syntax:
- Season:
%s{n} - Episode:
%e{n}
where the n in {n} specifies how many digits are in each of the sections.
Note: All spaces are converted to periods before your regular expression is run.
Python regular expression syntax can be found here
It is possible to set a custom output format for your files using the following syntax:
%n- Show%s- Season%e- Episode%t- Title%x- Extension
you can specify the format you like, i.e. %n - %s%e - $t%x would mirror the default format.
Note: Not including the %x section on Windows systems can cause problems when trying to run your media files.
On the command line use the -o switch or set the format option in the defaults section of your config file.
Please report any bugs or feature requests to the Tv Renamr Lighthouse account.
All colons ':' are converted to commas ',' in both the show name and the episode title. This stops issues that can arise with network shares and gives a cleaner format on windows where python replaces the colon character with a backslash ''.
Shows with a year in the canonical title, like Doctor Who (2005), will fail without specifying the show name which includes the year in brackets. You'll need to put this as the canonical name in the config file.
Multiple episode files are just not coped with at all. The first episode is usually picked up so the file will be renamed using this.