From d3b043dd4006d77170b7b553fdbc441f24fee0f3 Mon Sep 17 00:00:00 2001 From: desimaniac <5501908+desimaniac@users.noreply.github.com> Date: Tue, 11 Feb 2020 11:17:15 -0600 Subject: [PATCH] CLI: Renamed 'actor' parameter for person list type to 'person' This is to clarify that any non-actor name can be specified. --- README.md | 30 ++++++++++++++++-------------- traktarr.py | 44 ++++++++++++++++++++++---------------------- 2 files changed, 38 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 0bff66d..464f5ac 100644 --- a/README.md +++ b/README.md @@ -1216,10 +1216,11 @@ Options: -ma, --minimum-availability [announced|in_cinemas|released|predb] Add movies with this minimum availability to Radarr. Default is 'released'. - -a, --actor TEXT Only add movies from this actor to Radarr.Only one actor can be - specified.Requires the 'person' list. - --include-non-acting-roles Include non-acting roles such as 'As Himself', 'Narrator', etc. - Requires the 'person' list option with the 'actor' argument. + -p, --person TEXT Only add movies from this person (e.g. actor) to Radarr. Only + one person can be specified. Requires the 'person' list type. + --include-non-acting-roles Include non-acting roles such as 'Director', 'As Himself', + 'Narrator', etc. Requires the 'person' list type with the + 'person' argument. --no-search Disable search when adding movies to Radarr. --notifications Send notifications. --authenticate-user TEXT Specify which user to authenticate with to retrieve Trakt lists. @@ -1290,13 +1291,13 @@ Choices are: `anticipated`, `trending`, `popular`, `boxoffice`, `watched`, `play - Default is `released` (Physical/Web). -`-a`, `--actor` - Only add movies with a specific actor to Radarr. +`-p`, `--person` - Only add movies with a specific person to Radarr. - Requires the list type `person`. -`--include-non-acting-roles` - Include non-acting roles of the specified actor. +`--include-non-acting-roles` - Include non-acting roles of the specified person. - - Requires the list type `person` used with the `-a`/`--actor` option. + - Requires the list type `person` used with the `-p`/`--person` option. `--no-search` - Tells Radarr to not automatically search for added movies. @@ -1359,10 +1360,11 @@ Options: specified as a comma-separated list. Use 'ignore' to add shows from any genre, including ones with no genre specified. -f, --folder TEXT Add shows with this root folder to Sonarr. - -a, --actor TEXT Only add movies from this actor to Radarr. Only one actor can be - specified. Requires the 'person' list option. - --include-non-acting-roles Include non-acting roles such as 'As Himself', 'Narrator', etc. - Requires the 'person' list option with the 'actor' argument. + -p, --person TEXT Only add shows from this person (e.g. actor) to Sonarr. Only one + person can be specified. Requires the 'person' list type. + --include-non-acting-roles Include non-acting roles such as 'Director', 'As Himself', + 'Narrator', etc. Requires the 'person' list type with the + 'person' argument. --no-search Disable search when adding shows to Sonarr. --notifications Send notifications. --authenticate-user TEXT Specify which user to authenticate with to retrieve Trakt lists. @@ -1424,13 +1426,13 @@ Choices are: `anticipated`, `trending`, `popular`, `watched`, `played`, `URL` (T - Example: `-f /mnt/unionfs/Media/Shows/Shows-Kids/` -`-a`, `--actor` - Only add shows with a specific actor to Sonarr. +`-p`, `--person` - Only add shows with a specific person to Sonarr. - Requires the list type `person`. -`--include-non-acting-roles` - Include non-acting roles of the specified actor. +`--include-non-acting-roles` - Include non-acting roles of the specified person. - - Requires the list type `person` used with the `-a`/`--actor` option. + - Requires the list type `person` used with the `-p`/`--person` option. `--no-search` - Tells Sonarr to not automatically search for added shows. diff --git a/traktarr.py b/traktarr.py index 399a2f0..13392d4 100755 --- a/traktarr.py +++ b/traktarr.py @@ -314,16 +314,16 @@ def show( default=None, help='Add shows with this root folder to Sonarr.') @click.option( - '--actor', '-a', + '--person', '-p', default=None, - help='Only add shows from this actor to Sonarr. ' - 'Only one actor can be specified. ' - 'Requires the \'person\' list option.') + help='Only add shows from this person (e.g. actor) to Sonarr. ' + 'Only one person can be specified. ' + 'Requires the \'person\' list type.') @click.option( '--include-non-acting-roles', is_flag=True, - help='Include non-acting roles such as \'As Himself\', \'Narrator\', etc. \n' - 'Requires the \'person\' list option with the \'actor\' argument.') + help='Include non-acting roles such as \'Director\', \'As Himself\', \'Narrator\', etc. ' + 'Requires the \'person\' list type with the \'person\' argument.') @click.option( '--no-search', is_flag=True, @@ -334,7 +334,7 @@ def show( help='Send notifications.') @click.option( '--authenticate-user', - help='Specify which user to authenticate with to retrieve Trakt lists. \n' + help='Specify which user to authenticate with to retrieve Trakt lists. ' 'Defaults to first user in the config') @click.option( '--ignore-blacklist', @@ -352,7 +352,7 @@ def shows( years=None, genres=None, folder=None, - actor=None, + person=None, no_search=False, include_non_acting_roles=False, notifications=False, @@ -491,13 +491,13 @@ def shows( ) elif list_type.lower() == 'person': - if not actor: - log.error("You must specify an actor with the \'--actor\' / \'-a\' parameter when using the \'person\'" + + if not person: + log.error("You must specify an person with the \'--person\' / \'-p\' parameter when using the \'person\'" + " list type!") return None trakt_objects_list = trakt.get_person_shows( years=years, - person=actor, + person=person, countries=countries, languages=languages, genres=genres, @@ -825,16 +825,16 @@ def movie( type=click.Choice(['announced', 'in_cinemas', 'released', 'predb']), help='Add movies with this minimum availability to Radarr. Default is \'released\'.') @click.option( - '--actor', '-a', + '--person', '-p', default=None, - help='Only add movies from this actor to Radarr.' - 'Only one actor can be specified.' - 'Requires the \'person\' list.') + help='Only add movies from this person (e.g. actor) to Radarr. ' + 'Only one person can be specified. ' + 'Requires the \'person\' list type.') @click.option( '--include-non-acting-roles', is_flag=True, - help='Include non-acting roles such as \'As Himself\', \'Narrator\', etc. \n' - 'Requires the \'person\' list option with the \'actor\' argument.') + help='Include non-acting roles such as \'Director\', \'As Himself\', \'Narrator\', etc. ' + 'Requires the \'person\' list type with the \'person\' argument.') @click.option( '--no-search', is_flag=True, @@ -845,7 +845,7 @@ def movie( help='Send notifications.') @click.option( '--authenticate-user', - help='Specify which user to authenticate with to retrieve Trakt lists. \n' + help='Specify which user to authenticate with to retrieve Trakt lists. ' 'Defaults to first user in the config.') @click.option( '--ignore-blacklist', @@ -865,7 +865,7 @@ def movies( genres=None, folder=None, minimum_availability=None, - actor=None, + person=None, include_non_acting_roles=False, no_search=False, notifications=False, @@ -999,13 +999,13 @@ def movies( trakt_objects_list = trakt.get_boxoffice_movies() elif list_type.lower() == 'person': - if not actor: - log.error("You must specify an actor with the \'--actor\' / \'-a\' parameter when using the \'person\'" + + if not person: + log.error("You must specify an person with the \'--person\' / \'-p\' parameter when using the \'person\'" + " list type!") return None trakt_objects_list = trakt.get_person_movies( years=years, - person=actor, + person=person, countries=countries, languages=languages, genres=genres,