Plex
/
traktarr
mirror of https://github.com/l3uddz/traktarr
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Readme: updated for previous additions

Browse Source
pull/54/head
desimaniac 7 years ago
parent e331201e37
commit 24c03a2097
1 changed files with 104 additions and 45 deletions
Show Stats Download Patch File Download Diff File

149
README.md
Unescape View File

@ -1,5 +1,5 @@
# traktarr # traktarr
Script to add new shows & movies to Sonarr/Radarr based on Trakt lists. Add new shows & movies to Sonarr/Radarr from Trakt.
Types of Trakt lists supported: Types of Trakt lists supported:
@ -70,8 +70,8 @@ Repeat the following steps for every user you want to authenticate:
2. You wil get the following prompt: 2. You wil get the following prompt:
``` ```
INFO - media.trakt - __oauth_request_device_code - We're talking to Trakt to get your verification code. Please wait a moment... - We're talking to Trakt to get your verification code. Please wait a moment...
INFO - media.trakt - __oauth_request_device_code - Go to: https://trakt.tv/activate on any device and enter A0XXXXXX. We'll be polling Trakt every 5 seconds for a reply - Go to: https://trakt.tv/activate on any device and enter A0XXXXXX. We'll be polling Trakt every 5 seconds for a reply
``` ```
3. Go to https://trakt.tv/activate. 3. Go to https://trakt.tv/activate.
4. Enter the code you see in your terminal. 4. Enter the code you see in your terminal.
@ -220,7 +220,7 @@ Used for automatic / scheduled traktarr tasks.
Movies can be run on a separate schedule then from Shows. Movies can be run on a separate schedule then from Shows.
_Note: These settings are only needed if you plan to use traktarr on a schedule (i.e. via manual/CLI command only); see [Usage](#manual)._ _Note: These settings are only needed if you plan to use traktarr on a schedule (i.e. via manual/CLI command only); see [Usage](#usage)._
```json ```json
"automatic": { "automatic": {
@ -625,7 +625,7 @@ traktarr
``` ```
Usage: traktarr [OPTIONS] COMMAND [ARGS]... Usage: traktarr [OPTIONS] COMMAND [ARGS]...
Add new shows & movies to Sonarr/Radarr from Trakt lists. Add new shows & movies to Sonarr/Radarr from Trakt.
Options: Options:
--version Show the version and exit. --version Show the version and exit.
@ -634,14 +634,35 @@ Options:
--help Show this message and exit. --help Show this message and exit.
Commands: Commands:
movies Add new movies to Radarr. movie Add a single movie to Radarr.
movies Add multiple movies to Radarr.
run Run in automatic mode. run Run in automatic mode.
shows Add new shows to Sonarr. show Add a single show to Sonarr.
shows Add multiple shows to Sonarr.
trakt_authentication Authenticate traktarr. trakt_authentication Authenticate traktarr.
``` ```
### Movie (Single Movie)
### Movies ```
traktarr movie --help
```
```
Usage: traktarr movie [OPTIONS]
Add a single movie to Radarr.
Options:
-id, --movie_id TEXT Trakt movie_id. [required]
-f, --folder TEXT Add movie with this root folder to Radarr.
--no-search Disable search when adding movie to Radarr.
--help Show this message and exit.
```
_Note: `-id` and `--movie_id` support both Trakt IDs and IMDB IDs._
### Movies (Multiple Movies)
``` ```
traktarr movies --help traktarr movies --help
@ -651,78 +672,116 @@ traktarr movies --help
``` ```
Usage: traktarr movies [OPTIONS] Usage: traktarr movies [OPTIONS]
Add new movies to Radarr. Add multiple movies to Radarr.
Options: Options:
-t, --list-type TEXT Trakt list to process. For example, anticipated, -t, --list-type TEXT Trakt list to process. For example, anticipated,
trending, popular, boxoffice, watchlist or any trending, popular, boxoffice, watchlist or any URL
URL to a list [required] to a list [required]
-l, --add-limit INTEGER Limit number of movies added to Radarr. -l, --add-limit INTEGER Limit number of movies added to Radarr. [default:
[default: 0] 0]
-d, --add-delay FLOAT Seconds between each add request to Radarr. -d, --add-delay FLOAT Seconds between each add request to Radarr.
[default: 2.5] [default: 2.5]
-g, --genre TEXT Only add movies from this genre to Radarr. -g, --genre TEXT Only add movies from this genre to Radarr.
-f, --folder TEXT Add movies with this root folder to Radarr. -f, --folder TEXT Add movies with this root folder to Radarr.
--no-search Disable search when adding movies to Radarr. --no-search Disable search when adding movies to Radarr.
--notifications Send notifications. --notifications Send notifications.
--authencate-user TEXT Specify which user to authenticate with to --authenticate-user TEXT Specify which user to authenticate with to
retrieve Trakt lists. Default: first user in the retrieve Trakt lists. Default: first user in the
config. config.
--help Show this message and exit.
``` ```
### Show (Single Show)
```
traktarr show --help
```
```
Usage: traktarr show [OPTIONS]
Add a single show to Sonarr.
Options:
-id, --show_id TEXT Trakt show_id. [required]
-f, --folder TEXT Add show with this root folder to Sonarr.
--no-search Disable search when adding show to Sonarr.
--help Show this message and exit.
```
_Note: `-id` and `--show_id` support both Trakt IDs and IMDB IDs._
### Shows (Multiple Shows)
```
traktarr shows --help
```
### Shows
``` ```
Usage: traktarr shows [OPTIONS] Usage: traktarr shows [OPTIONS]
Add new shows to Sonarr. Add multiple shows to Sonarr.
Options: Options:
-t, --list-type TEXT Trakt list to process. For example, anticipated, -t, --list-type TEXT Trakt list to process. For example, anticipated,
trending, popular, watchlist or any URL to a trending, popular, watchlist or any URL to a list
list [required] [required]
-l, --add-limit INTEGER Limit number of shows added to Sonarr. -l, --add-limit INTEGER Limit number of shows added to Sonarr. [default:
[default: 0] 0]
-d, --add-delay FLOAT Seconds between each add request to Sonarr. -d, --add-delay FLOAT Seconds between each add request to Sonarr.
[default: 2.5] [default: 2.5]
-g, --genre TEXT Only add shows from this genre to Sonarr. -g, --genre TEXT Only add shows from this genre to Sonarr.
-f, --folder TEXT Add shows with this root folder to Sonarr. -f, --folder TEXT Add shows with this root folder to Sonarr.
--no-search Disable search when adding shows to Sonarr. --no-search Disable search when adding shows to Sonarr.
--notifications Send notifications. --notifications Send notifications.
--authencate-user TEXT Specify which user to authenticate with to --authenticate-user TEXT Specify which user to authenticate with to
retrieve Trakt lists. Default: first user in the retrieve Trakt lists. Default: first user in the
config. config
--help Show this message and exit. --help Show this message and exit.
``` ```
## Examples (Manual) ## Examples (Manual)
- Fetch boxoffice movies, labeled with the comedy genre, limited to 10 items, and send notifications: - Add the movie "Black Panther (2018)":
```
traktarr movie -id black-panther-2018
```
- Add the show "The 100":
```
traktarr show -id the-100
```
- Add boxoffice movies, labeled with the comedy genre, limited to 10 items, and send notifications:
``` ```
traktarr movies -t boxoffice -g comedy -l 10 --notifications traktarr movies -t boxoffice -g comedy -l 10 --notifications
``` ```
- Fetch popular shows, limited to 2 items, and don't start the search in Sonarr: - Add popular shows, limited to 2 items, and don't start the search in Sonarr:
``` ```
traktarr shows -t popular -l 2 --no-search traktarr shows -t popular -l 2 --no-search
``` ```
- Fetch all shows from the watchlist of `user1`: - Add all shows from the watchlist of `user1`:
``` ```
traktarr shows -t watchlist --authenticate-user user1 traktarr shows -t watchlist --authenticate-user user1
``` ```
- Fetch all movies from the public list `https://trakt.tv/users/rkerwin/lists/top-100-movies`: - Add all movies from the public list `https://trakt.tv/users/rkerwin/lists/top-100-movies`:
``` ```
traktarr movies -t https://trakt.tv/users/rkerwin/lists/top-100-movies traktarr movies -t https://trakt.tv/users/rkerwin/lists/top-100-movies
``` ```
- Fetch all movies from the private list `https://trakt.tv/users/user1/lists/private-movies-list` of `user1`: - Add all movies from the private list `https://trakt.tv/users/user1/lists/private-movies-list` of `user1`:
``` ```
traktarr movies -t https://trakt.tv/users/user1/lists/private-movies-list --authenticate-user=user1 traktarr movies -t https://trakt.tv/users/user1/lists/private-movies-list --authenticate-user=user1

Write Preview
Loading…
Cancel
Save