pycliarr.cli.cli_cmd module¶

class pycliarr.cli.cli_cmd.CliAddMovieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Add a movie from the imdb/tmdb id, or look for keywords'¶

name = 'add'¶

run(cli: pycliarr.api.radarr.RadarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliAddSerieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Add a serie from the tvdb id, or look for keywords'¶

name = 'add'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliApiCommand(name: str, cli_class: Any, commands: List[pycliarr.cli.cli_cmd.CliCommand])[source]¶

Bases: object

Definition of an API client.

Allows instantiating the relevant communication client, and execute a subcommmand from its name.

add_commands_args(cmd_subparser: argparse._SubParsersAction) → None[source]¶

run_command(cmd_name: str, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliCommand[source]¶

Bases: object

Base command, all command should extend this class.

configure_args(cmdlist_parser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = ''¶

name = ''¶

run(cli: Any, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliCreateRadarrExclusionCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Create the specified exclusion'¶

name = 'create-exclusion'¶

run(cli: pycliarr.api.radarr.RadarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliCreateSonarrExclusionCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Create the specified exclusion'¶

name = 'create-exclusion'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliCreateTagCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Create the specified tag'¶

name = 'create-tag'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliDeleteBlocklistCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get list of quality profiles'¶

name = 'delete-blocklist'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliDeleteEpisodeFileCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get info on a of serie'¶

name = 'delete-episode-file'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliDeleteExclusionCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Delete the specified exclusion'¶

name = 'delete-exclusion'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliDeleteMovieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Delete a movie'¶

name = 'delete'¶

run(cli: pycliarr.api.radarr.RadarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliDeleteNotificationCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Delete the specified notification or all'¶

name = 'delete-notification'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliDeleteQueueCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get list of quality profiles'¶

name = 'delete-queue'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliDeleteSerieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Delete a serie'¶

name = 'delete'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliDeleteTagCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Delete the specified tag'¶

name = 'delete-tag'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliEditMovieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Push an updated item to the movie library'¶

name = 'edit'¶

run(cli: pycliarr.api.radarr.RadarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliEditTagCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Edit the specified tag'¶

name = 'edit-tag'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliEpisodeCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get info on an episode'¶

name = 'get-episode'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetBlocklistCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get blocklisted items'¶

name = 'blocklist'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetCalendarCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get events from calendar'¶

name = 'calendar'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetDiskSpaceCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

description = 'Get disk space'¶

name = 'disk-space'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetEpisodeFileCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get info on an episode file'¶

name = 'get-episode-file'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetExclusionCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get exclusion(s)'¶

name = 'exclusion'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetMovieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get info on a of movie'¶

name = 'get'¶

run(cli: pycliarr.api.radarr.RadarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetNotificationCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get notification(s)'¶

name = 'notification'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetProfilesCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

description = 'Get list of quality profiles'¶

name = 'profiles'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetQueueCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get current downloading queue'¶

name = 'queue'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetRefreshMovieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Refresh movies'¶

name = 'refresh'¶

run(cli: pycliarr.api.radarr.RadarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetRefreshSerieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Refresh series'¶

name = 'refresh'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetRescanMovieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Rescan movies'¶

name = 'rescan'¶

run(cli: pycliarr.api.radarr.RadarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetRescanSerieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Rescan series'¶

name = 'rescan'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetSerieCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get info on a of serie'¶

name = 'get'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetTagCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get tag(s)'¶

name = 'tag'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetTagDetailCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get tag(s) details'¶

name = 'tag-detail'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliGetTagItemsCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'List items with specifed tag'¶

name = 'tag-items'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliPutNotificationCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Create the specified notification'¶

name = 'put-notification'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliRootFoldersCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get root folder list'¶

name = 'root-folders'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliSearchMissingEpisodes[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

description = 'Search missing episods'¶

name = 'search-missing'¶

run(cli: pycliarr.api.sonarr.SonarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliSearchMissingMovies[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

description = 'Search missing movies'¶

name = 'search-missing'¶

run(cli: pycliarr.api.radarr.RadarrCli, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliStatusCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'Get status of 1 or all currently running commands'¶

name = 'status'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliSystemStatusCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

description = 'Get system status'¶

name = 'system-status'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

class pycliarr.cli.cli_cmd.CliWantedCommand[source]¶

Bases: pycliarr.cli.cli_cmd.CliCommand

configure_args(cmd_subparser: argparse._SubParsersAction) → argparse.ArgumentParser[source]¶

description = 'List wanted/missing'¶

name = 'wanted'¶

run(cli: pycliarr.api.base_media.BaseCliMediaApi, args: argparse.Namespace) → None[source]¶

pycliarr.cli.cli_cmd.print_root_folder(cli: pycliarr.api.base_media.BaseCliMediaApi, raw=<class 'bool'>) → None[source]¶

pycliarr.cli.cli_cmd.root_folder_id_from_arg(cli: pycliarr.api.base_media.BaseCliMediaApi, root_arg: str) → int[source]¶

pycliarr.cli.cli_cmd.select_item(terms: str, choices: List[Union[pycliarr.api.radarr.RadarrMovieItem, pycliarr.api.sonarr.SonarrSerieItem]]) → Union[pycliarr.api.radarr.RadarrMovieItem, pycliarr.api.sonarr.SonarrSerieItem][source]¶

pycliarr.cli.cli_cmd.select_language_profile(cli: pycliarr.api.base_media.BaseCliMediaApi) → int[source]¶

pycliarr.cli.cli_cmd.select_profile(cli: pycliarr.api.base_media.BaseCliMediaApi) → int[source]¶

pycliarr.cli.cli_cmd.select_root_folder(cli: pycliarr.api.base_media.BaseCliMediaApi) → int[source]¶