Available Configuration Options

DEFAULT

locations

Type:multi-valued Default:

specify the paths to search for files to rename.

dryrun

Type:boolean Default:false

Practice run where no changes are applied.

cache_enabled

Type:boolean Default:true

Enable caching results

console_output_enabled

Type:boolean Default:true

Enable console output

logfile

Type:string Default:tvrenamer.log

specify name of log file default: the value above

loglevel

Type:string Default:info Valid Values:none, critical, error, warning, info, debug, trace

specify logging level to log messages: %(choices)s

move_files_enabled

Type:boolean Default:false

Move files to library during rename.

overwrite_file_enabled

Type:boolean Default:false

Overwrite existing files during rename.

default_library

Type:string Default:

Default library path to relocate files to.

libraries

Type:list Default:

Library paths to relocate files to.

language

Type:string Default:en

Lanuage to lookup metadata in.

valid_extensions

Type:list Default:

File extensions considered valid.

filename_blacklist

Type:list Default:

File names exclused from processing.

input_filename_replacements

Type:list Default:

List of mappings of string pattern replacements.

input_series_replacements

Type:dict Default:

Mapping of parsed series name to replacement values.

output_series_replacements

Type:dict Default:

Mapping of lookup series name to replacement values.

lookup_service

Type:string Default:tvdb

Name of lookup service to use for metadata retrieval.

directory_name_format

Type:string Default:.

Format for naming library directories.

filename_format_ep

Type:string Default:%(seriesname)s - %(seasonnumber)02dx%(episode)s - %(episodename)s%(ext)s

Format for naming files with episode name.

episode_single

Type:string Default:%02d

Format for episode numbers.

episode_separator

Type:string Default:-

Separator to join multiple episode numbers.

multiep_join_name_with

Type:string Default:", "

Separator to join multiple episodes.

multiep_format

Type:string Default:%(epname)s (%(episodemin)s-%(episodemax)s)

Format for naming multiple episodes.

filename_character_blacklist

Type:string Default:

Characters to ignore within filename.

replacement_character

Type:string Default:_

Character used to replace invalid characters.

output_filename_replacements

Type:list Default:

List of mappings of string pattern replacements.

cache

dbfile

Type:string Default:$config_dir/cache.json

The full path of the database storage.

tvdb

apikey

Type:string Default:<None>

API key from your TVDB account ENV[‘TVDB_API_KEY’]

username

Type:string Default:<None>

Username from your TVDB account ENV[‘TVDB_USERNAME’]

userpass

Type:string Default:<None>

Password from your TVDB account ENV[‘TVDB_PASSWORD’]

service_url

Type:string Default:https://api-dev.thetvdb.com

the url for thetvdb api service

verify_ssl_certs

Type:boolean Default:true

flag for validating ssl certs for service url (https)

select_first

Type:boolean Default:false

flag for selecting first series from search results

trakt

client_id

Type:string Default:<None>

client id from your trakt account ENV[‘TRAKT_CLIENT_ID’]

client_secret

Type:string Default:<None>

client secret from your trakt account ENV[‘TRAKT_CLIENT_SECRET’]