Config API¶

Auto-generated reference for the Config object that models the unshackle configuration file. For a human-friendly walkthrough of every key, see the Configuration Reference.

Config ¶

Config(**kwargs)

get_folder_template ¶

get_folder_template(kind)

Resolve the folder template for the given title kind.

kind: one of "movies", "series", "songs", "albums". Falls back to the legacy single-string folder template, then "".

get_template_separator ¶

get_template_separator(template_type='movies')

Get the filename separator for the given template type.

Analyzes the active template to determine whether it uses dots or spaces between variables. Falls back to dot separator (scene-style) by default.

Parameters:

Name	Type	Description	Default
`template_type`	`str`	One of "movies", "series", or "songs".	`'movies'`

resolve_decryption ¶

resolve_decryption(decryption_map, default, service)

Pick the decryption tool for a service (case-insensitive), falling back to default.

resolve_cdm_name ¶

resolve_cdm_name(cdm, service, override=None)

Resolve a service's top-level CDM entry (case-insensitive), with default fallback.

get_config_path ¶

get_config_path()

Get Path to Config from any one of the possible locations.

Returns None if no config file could be found.