From 826d6915fa737d702a55380649fff9065934f72c Mon Sep 17 00:00:00 2001 From: desimaniac <5501908+desimaniac@users.noreply.github.com> Date: Sat, 21 Sep 2019 16:14:44 -0500 Subject: [PATCH] Readme: Added more details on rating_limit and OMDb. --- README.md | 18 ++++++++++++------ traktarr.py | 2 +- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 586f359..aa3e7cd 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ - [Sonarr](#sonarr) - [Tags](#tags) - [Trakt](#trakt) + - [OMDb](#omdb) - [Usage](#usage) - [Automatic (Scheduled)](#automatic-scheduled) - [Setup](#setup) @@ -611,7 +612,7 @@ Use filters to specify the movie/shows's country of origin or blacklist (i.e. fi ], ``` -`rating_limit` - Only add movies above this Rotten Tomatoes score. +`rating_limit` - Only add movies that are equal to or above this Rotten Tomatoes score. Requires an OMDb API Key (see [below](#omdb)). ### Shows @@ -981,20 +982,25 @@ Trakt Authentication info: } ``` -`client_id` - Fill in your Trakt API key (_Client ID_). +`client_id` - Your Trakt API Key (_Client ID_). -`client_secret` - Fill in your Trakt Secret key (_Client Secret_) +`client_secret` - Your Trakt Secret Key (_Client Secret_). -## OMDB +## OMDb -OMDB Authentication info: +[OMDb](https://www.omdbapi.com/) Authentication info. ```json "omdb": { "api_key":"" } ``` -`api_key` - Fill in your OMDB API key (*This is only needed if you wish to use rating filtering on adding movies from command line/automatic*) + +`api_key` - Your [OMDb](https://www.omdbapi.com/) API Key. + +- This is only needed if you wish to use a minimum Rotten Tomatoes score to filter out movies. + +- Use `rating_limit` in config for automatic scheduling or `--rating` as an argument for CLI. # Usage diff --git a/traktarr.py b/traktarr.py index 6c8e082..a1092d2 100755 --- a/traktarr.py +++ b/traktarr.py @@ -704,7 +704,7 @@ def movies(list_type, add_limit=0, add_delay=2.5, sort='votes', rating=None, gen if 'omdb' in cfg and 'api_key' in cfg['omdb'] and cfg['omdb']['api_key']: log.info("Minimum Rotten Tomatoes score of %d%% requested.", rating) else: - log.info("Skipping minimum Rotten Tomatoes score check as OMDb api key is missing.") + log.info("Skipping minimum Rotten Tomatoes score check as OMDb API Key is missing.") # loop movies log.info("Processing list now...")