desimaniac
d4270213d2
|
6 years ago | |
---|---|---|
assets | 7 years ago | |
docker | 7 years ago | |
helpers | 7 years ago | |
media | 7 years ago | |
misc | 7 years ago | |
notifications | 7 years ago | |
systemd | 7 years ago | |
.dockerignore | 7 years ago | |
.gitignore | 7 years ago | |
LICENSE.md | 7 years ago | |
README.md | 7 years ago | |
config.json.sample | 7 years ago | |
list_of_country_codes.md | 7 years ago | |
list_of_language_codes.md | 7 years ago | |
list_of_movie_genres.md | 7 years ago | |
list_of_show_genres.md | 7 years ago | |
requirements.txt | 7 years ago | |
traktarr.py | 6 years ago |
README.md
traktarr
traktarr uses Trakt to add new shows into Sonarr and new movies into Radarr.
Types of Trakt lists supported:
-
Official Trakt Lists
-
Trending
-
Popular
-
Anticipated
-
Boxoffice
-
Most Watched
-
Most Played
-
-
Public Lists
-
Private Lists*
-
Watchlist
-
Custom List(s)
-
* Support for multiple (authenticated) users.
Demo
Click to enlarge.
Requirements
-
Ubuntu/Debian
-
Python 3.5 or higher (
sudo apt install python3 python3-pip
). -
requirements.txt modules (see below).
Installation
1. Base Install
Install traktarr to be run with traktarr
command.
-
cd /opt
-
sudo git clone https://github.com/l3uddz/traktarr
-
sudo chown -R user:group traktarr
(runid
to find your user / group) -
cd traktarr
-
sudo python3 -m pip install -r requirements.txt
-
sudo ln -s /opt/traktarr/traktarr.py /usr/local/bin/traktarr
-
traktarr
- run once to generate a sample a config.json file. -
nano config.json
- edit preferences.
2. Create a Trakt Application
-
Create a Trakt application by going here
-
Enter a name for your application; for example
traktarr
-
Enter
urn:ietf:wg:oauth:2.0:oob
in theRedirect uri
field. -
Click "SAVE APP".
-
Open the traktarr configuration file
config.json
and insert the Client ID in theclient_id
and the Client Secret in theclient_secret
, like this:{ "trakt": { "client_id": "my_client_id", "client_secret": "my_client_secret_key" } }
3. Authenticate User(s) (optional)
For each user you want to access the private lists for (i.e. watchlist and/or custom lists), you will need to to authenticate that user.
Repeat the following steps for every user you want to authenticate:
-
Run
traktarr trakt_authentication
-
You wil get the following prompt:
- We're talking to Trakt to get your verification code. Please wait a moment... - 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.
-
Enter the code you see in your terminal.
-
Click continue.
-
If you are not logged in to Trakt, login now.
-
Click "Accept".
-
You will get the message: "Woohoo! Your device is now connected and will automatically refresh in a few seconds.".
You've now authenticated the user.
You can repeat this process for as many users as you like.
Configuration
Sample Configuration
{
"core": {
"debug": false
},
"automatic": {
"movies": {
"anticipated": 3,
"boxoffice": 10,
"interval": 24,
"popular": 3,
"trending": 2
},
"shows": {
"anticipated": 10,
"interval": 48,
"popular": 1,
"trending": 2
}
},
"filters": {
"movies": {
"disabled_for": [],
"allowed_countries": [
"us",
"gb",
"ca"
],
"allowed_languages": [],
"blacklist_title_keywords": [
"untitled",
"barbie",
"ufc"
],
"blacklisted_genres": [
"documentary",
"music",
"animation"
],
"blacklisted_max_year": 2019,
"blacklisted_min_runtime": 60,
"blacklisted_min_year": 2000,
"blacklisted_tmdb_ids": []
},
"shows": {
"disabled_for": [],
"allowed_countries": [
"us",
"gb",
"ca"
],
"allowed_languages": [],
"blacklisted_genres": [
"animation",
"game-show",
"talk-show",
"home-and-garden",
"children",
"reality",
"anime",
"news",
"documentary",
"special-interest"
],
"blacklisted_max_year": 2019,
"blacklisted_min_runtime": 15,
"blacklisted_min_year": 2000,
"blacklisted_networks": [
"twitch",
"youtube",
"nickelodeon",
"hallmark",
"reelzchannel",
"disney",
"cnn",
"cbbc",
"the movie network",
"teletoon",
"cartoon network",
"espn",
"yahoo!",
"fox sports"
],
"blacklisted_tvdb_ids": []
}
},
"notifications": {
"pushover": {
"service": "pushover",
"app_token": "",
"user_token": "",
"priority": 0
},
"slack": {
"service": "slack",
"webhook_url": ""
},
"verbose": true
},
"radarr": {
"api_key": "",
"profile": "HD-1080p",
"root_folder": "/movies/",
"url": "http://localhost:7878/"
},
"sonarr": {
"api_key": "",
"profile": "HD-1080p",
"root_folder": "/tv/",
"tags": {},
"url": "http://localhost:8989/"
},
"trakt": {
"client_id": "",
"client_secret": ""
}
}
Core
"core": {
"debug": false
},
debug
- Toggle debug messages in the log. Default is false
.
- Set to
true
, if you are having issues and want to diagnose why.
Automatic
Used for automatic / scheduled traktarr tasks.
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 (vs just using it as a CLI command only; see Usage).
"automatic": {
"movies": {
"anticipated": 3,
"boxoffice": 10,
"interval": 24,
"popular": 3,
"trending": 2,
"watched": 2,
"played_all": 2,
"watchlist": {},
"lists": {},
},
"shows": {
"anticipated": 10,
"interval": 48,
"popular": 1,
"trending": 2,
"watched_monthly": 2,
"played": 2,
"watchlist": {},
"lists": {}
}
},
interval
- Specify how often (in hours) to run traktarr task.
anticipated
, popular
, trending
, boxoffice
(movies only) - Specify how many items from each Trakt list to find.
watched
- Adds items that are the most watched by unique Trakt users (mutliple viewings excluded).
-
watched
/watched_weekly
- Most watched in the week. -
watched_monthly
- Most watched in the month. -
watched_yearly
- Most watched in the year. -
watched_all
- Most watched of all time.
played
- Adds items that are most the played items by Trakt users (mutliple viewings included).
-
played
/played_weekly
- Most played in the week. -
played_monthly
- Most played in the month. -
played_yearly
- Most played in the year. -
played_all
Most played of all time.
watchlist
- Specify which watchlists to fetch (see explanation below).
lists
- Specify which custom lists to fetch (see explanation below).
Personal Watchlists
The watchlist task can be scheduled with a differtent item limit for every (authenticated) user.
So for every user, you will add: "username": limit
to the watchlist key. For example:
"automatic": {
"movies": {
"watchlist": {
"user1": 10,
"user2": 5
}
},
"shows": {
"watchlist": {
"user1": 2,
"user3": 1
}
}
},
Of course you can combine this with running the other list types as well.
Custom Lists
You can also schedule any number of public or private custom lists.
For both public and private lists you'll need the url to that list. When viewing the list on Trakt, simply copy the url from the address bar of the your browser.
Public Lists
Public lists can be added by specifying the url and the item limit like this:
"automatic": {
"movies": {
"lists": {
"https://trakt.tv/users/rkerwin/lists/top-100-movies": 10
}
},
"shows": {
"lists": {
"https://trakt.tv/users/claireaa/lists/top-100-tv-shows-of-all-time-ign": 10
}
}
},
Private Lists
Private lists can be added in two ways:
-
If there is only one authenticated user, you can add the private list just like any other public list:
"automatic": { "movies": { "lists": { "https://trakt.tv/users/user/lists/my-private-movies-list": 10 } }, "shows": { "lists": { "https://trakt.tv/users/user/lists/my-private-shows-list": 10 } } },
-
If there are multiple authenticated users you want to fetch the lists from, you'll need to specify the username under
authenticate_as
.Note: The user should have access to the list (either own the list or a list that was shared to them by a friend).
"automatic": { "movies": { "lists": { "https://trakt.tv/users/user/lists/my-private-movies-list": { "authenticate_as": "user2", "limit": 10 } } }, "shows": { "lists": { "https://trakt.tv/users/user/lists/my-private-shows-list": { "authenticate_as": "user2", "limit": 10 } } } },
Filters
Use filters to specify the movie/shows's country of origin or blacklist (i.e. filter-out) certain keywords, genres, years, runtime, or specific movies/shows.
Movies
"movies": {
"disabled_for": [],
"allowed_countries": [
"us",
"gb",
"ca"
],
"allowed_languages": [],
"blacklist_title_keywords": [
"untitled",
"barbie"
],
"blacklisted_genres": [
"documentary",
"music",
"animation"
],
"blacklisted_max_year": 2019,
"blacklisted_min_runtime": 60,
"blacklisted_min_year": 2000,
"blacklisted_tmdb_ids": []
},
disabled_for
- Specify for which lists the blacklist is disabled for, when running in automatic mode.
- This is similar to running
--ignore-blacklist
via the CLI command.
Example:
"disabled_for": [
"anticipated",
"watchlist:user1",
"list:http://url-to-list"
],
allowed_countries
- Only add movies from these countries. Listed as two-letter country codes.
allowed_languages
- Only add movies with these languages. Listed as two-letter language codes.
-
By default, traktarr will only query movies in English. If you need to search for other languages (e.g. Japanese for anime), you must add those languages here.
-
Languages are in ISO 639-1 format (e.g.
ja
for Japanese.)
blacklist_title_keywords
- blacklist certain words in titles.
blacklisted_genres
- Blacklist certain genres.
-
For an updated list, visit here.
blacklisted_max_year
- Blacklist release dates after specified year.
blacklisted_min_runtime
- Blacklist runtime duration lower than specified time (in minutes).
blacklisted_min_year
- Blacklist release dates before specified year.
blacklisted_tmdb_ids
- Blacklist certain movies with their TMDB IDs.
Shows
"shows": {
"allowed_countries": [
"us",
"gb",
"ca"
],
"allowed_languages": [],
"blacklisted_genres": [
"animation",
"game-show",
"talk-show",
"home-and-garden",
"children",
"reality",
"anime",
"news",
"documentary",
"special-interest"
],
"blacklisted_max_year": 2019,
"blacklisted_min_runtime": 15,
"blacklisted_min_year": 2000,
"blacklisted_networks": [
"twitch",
"youtube",
"nickelodeon",
"hallmark",
"reelzchannel",
"disney",
"cnn",
"cbbc",
"the movie network",
"teletoon",
"cartoon network",
"espn",
"yahoo!",
"fox sports"
],
"blacklisted_tvdb_ids": []
}
disabled_for
- Specify for which lists the blacklist is disabled for, when running in automatic mode.
- This is similar to running
--ignore-blacklist
via the CLI command.
Example:
"disabled_for": [
"anticipated",
"watchlist:user1",
"list:http://url-to-list"
],
allowed_countries
- Only add shows from these countries. Listed as two-letter country codes.
allowed_languages
- Only add shows with these languages.
-
By default, traktarr will only query shows in English. If you need to search for other languages (e.g. Japanese for anime), you must add those languages here.
-
Languages are in ISO 639-1 format (e.g.
ja
for Japanese.)
blacklisted_genres
- Blacklist certain genres.
-
For an updated list, visit here.
blacklisted_max_year
- Blacklist release dates after specified year.
blacklisted_min_runtime
- Blacklist runtime duration lower than specified time (in minutes).
blacklisted_min_year
- Blacklist release dates before specified year.
blacklisted_networks
- Blacklist certain network.
blacklisted_tvdb_ids
- Blacklist certain shows with their TVDB IDs.
Notifications
Notification alerts for traktarr tasks.
Note: Manual commands need the --notifications
flag.
Currently, only Pushover and Slack are supported. More will be added later.
"notifications": {
"pushover": {
"service": "pushover",
"app_token": "",
"user_token": "",
"priority": 0
},
"slack": {
"service": "slack",
"webhook_url": ""
},
"verbose": true
},
verbose
- Toggle detailed notifications. Default is true
.
- Set to
false
, if you want to reduce the amount of detailed notifications (e.g. the names of the movies/shows added vs just the total).
Pushover
app_token
and user_token
- Retrieve from Pushover.net.
You can specify a priority for the messages send via Pushover using the priority
key. It can be any Pushover priority value (https://pushover.net/api#priority).
Note: The key name (i.e the name right under notifications) can be anything, but the "service":
must be exactly "pushover"
.
Slack
webhook_url
- Webhook URL you get after creating an "Incoming Webhook" under "Custom Integrations".
Note: The key name (i.e the name right under notifications) can be anything, but the "service":
must be exactly "slack"
.
Radarr
Radarr configuration.
"radarr": {
"api_key": "",
"profile": "HD-1080p",
"root_folder": "/movies/",
"url": "http://localhost:7878"
},
api_key
- Radarr's API Key.
profile
- Profile that movies are assigned to.
root_folder
- Root folder for movies.
url
- Radarr's URL.
Sonarr
Sonarr configuration.
"sonarr": {
"api_key": "",
"profile": "HD-1080p",
"root_folder": "/tv/",
"tags": {},
"url": "http://localhost:8989"
},
api_key
- Sonarr's API Key.
profile
- Profile that TV shows are assigned to.
root_folder
- Root folder for TV shows.
tags
- Assign tags to shows based the network it airs on. More details on this below.
url
- Sonarr's URL.
Tags
The tags
option allows Sonarr to assign tags to shows from specific television networks, so that Sonarr can filter in/out certain keywords from releases.
Example:
To show how tags work, we will create a tag AMZN
and assign it to certain television networks that usually have AMZN releases.
-
First, we will create a tag in Sonarr (Settings > Indexers > Restrictions).
Must contain: BluRay, Amazon, AMZN Must not contain: Tags: AMZN
-
And, finally, we will edit the traktarr config and assign the
AMZN
tag to some networks."tags": { "amzn": [ "hbo", "amc", "usa network", "tnt", "starz", "the cw", "fx", "fox", "abc", "nbc", "cbs", "tbs", "amazon", "syfy", "cinemax", "bravo", "showtime", "paramount network" ] }
Trakt
Trakt Authentication info:
"trakt": {
"client_id": "",
"client_secret": ""
}
client_id
- Fill in your Trakt API key (Client ID).
client_secret
- Fill in your Trakt Secret key (Client Secret)
Usage
Automatic (Scheduled)
Setup
To have traktarr get Movies and Shows for you automatically, on set interval, do the following:
-
sudo cp /opt/traktarr/systemd/traktarr.service /etc/systemd/system/
-
sudo nano /etc/systemd/system/traktarr.service
and edit user/group to match yours' (runid
to check). -
sudo systemctl daemon-reload
-
sudo systemctl enable traktarr.service
-
sudo systemctl start traktarr.service
Customize
You can customize how the scheduled traktarr is ran by editing the traktarr.service
file and adding any of the following options:
* Remember, other configuration options need to go into the config.json
file under the Automatic
section.
traktarr run --help
Usage: traktarr run [OPTIONS]
Run in automatic mode.
Options:
-d, --add-delay FLOAT Seconds between each add request to Sonarr /
Radarr. [default: 2.5]
-s, --sort [votes|rating|release]
Sort list to process.
--no-search Disable search when adding to Sonarr /
Radarr.
--run-now Do a first run immediately without waiting.
--no-notifications Disable notifications.
--ignore-blacklist Ignores the blacklist when running the
command.
--help Show this message and exit.
-d
, --add-delay
- Add seconds delay between each add request to Sonarr / Radarr. Dfault is 2.5 seconds.
- Example:
-d 5
-s
, --sort
- Sort list by highest votes
, highest rating
, or the latest release
dates. Default is highest votes
.
- Example:
-s release
--no-search
- Tells Sonarr / Radarr to not automatically search for added shows / movies.
--run-now
- Traktarr will run first automated search on start, without waiting for next interval.
--no-notifications
- Disable notifications. Default is enabled
.
--ignore-blacklist
- Ignores blacklist filtering. Equivalent of disabled_for
in config.json.
Example of a modified line from the traktarr.service file that will always add from the most recent releases matched:
ExecStart=/usr/bin/python3 /opt/traktarr/traktarr.py run -s release
Manual (CLI)
General
traktarr
Usage: traktarr [OPTIONS] COMMAND [ARGS]...
Add new shows & movies to Sonarr/Radarr from Trakt.
Options:
--version Show the version and exit.
--config PATH Configuration file [default: /opt/traktarr/config.json]
--logfile PATH Log file [default: /opt/traktarr/activity.log]
--help Show this message and exit.
Commands:
movie Add a single movie to Radarr.
movies Add multiple movies to Radarr.
run Run in automatic mode.
show Add a single show to Sonarr.
shows Add multiple shows to Sonarr.
trakt_authentication Authenticate traktarr.
Movie (Single Movie)
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: This command only works with -id
or --show_id
specified (i.e. not with lists), and supports both Trakt IDs and IMDB IDs.
Movies (Multiple Movies)
traktarr movies --help
Usage: traktarr movies [OPTIONS]
Add multiple movies to Radarr.
Options:
-t, --list-type TEXT Trakt list to process. For example,
anticipated, trending, popular, boxoffice,
watched, played, watchlist or any URL to a
list [required]
-l, --add-limit INTEGER Limit number of movies added to Radarr.
[default: 0]
-d, --add-delay FLOAT Seconds between each add request to Radarr.
[default: 2.5]
-s, --sort [votes|rating|release]
Sort list to process.
-g, --genre TEXT Only add movies from this genre to Radarr.
-f, --folder TEXT Add movies with this root folder to Radarr.
--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. Default: first user in
the config.
--ignore-blacklist Ignores the blacklist when running the
command.
--help Show this message and exit.
-t
, --list-type
- Trakt list to process. Choices are: anticipated
, trending
, popular
, boxoffice
, watched
, played
, URL
(trakt list).
-
Watched Lists: Movies that are the most watched by unique Trakt users (mutliple viewings excluded).
-
watched
/watched_weekly
- Most watched in the week. -
watched_monthly
- Most watched in the month. -
watched_yearly
- Most watched in the year. -
watched_all
- Most watched of all time.
-
-
Played Lists: Movies that are the most played by Trakt users (mutliple viewings included).
-
played
/played_weekly
- Most played in the week. -
played_monthly
- Most played in the month. -
played_yearly
- Most played in the year. -
played_all
Most played of all time.
-
-l
, --add-limit
- Limit number of movies added to Radarr.
-d
, --add-delay
- Add seconds delay between each add request to Radarr. Default is 2.5 seconds.
- Example:
-d 5
-s
, --sort
- Sort list by highest votes
, highest rating
, or the latest release
dates. Default is highest votes
.
- Example:
-s release
-g
, --genre
- Only add movies from this genre to Radarr.
- Can find a list here.
-f
, --folder
- Add shows to a specific root folder in Radarr.
- Example:
-f /mnt/unionfs/Media/Movies/Movies-Kids/
--no-search
- Tells Radarr to not automatically search for added movies.
--notifications
- To enable notifications. Default is disabled
.
--ignore-blacklist
- Ignores blacklist filtering. Equivalent of disabled_for
in config.json.
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: This command only works with -id
or --show_id
specified (i.e. not with lists), and supports both Trakt IDs and IMDB IDs.
Shows (Multiple Shows)
traktarr shows --help
Usage: traktarr shows [OPTIONS]
Add multiple shows to Sonarr.
Options:
-t, --list-type TEXT Trakt list to process. For example,
anticipated, trending, popular, watched,
played, watchlist or any URL to a list
[required]
-l, --add-limit INTEGER Limit number of shows added to Sonarr.
[default: 0]
-d, --add-delay FLOAT Seconds between each add request to Sonarr.
[default: 2.5]
-s, --sort [votes|rating|release]
Sort list to process.
-g, --genre TEXT Only add shows from this genre to Sonarr.
-f, --folder TEXT Add shows with this root folder to Sonarr.
--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. Default: first user in
the config
--ignore-blacklist Ignores the blacklist when running the
command.
--help Show this message and exit.
-t
, --list-type
- Trakt list to process. Choices are: anticipated
, trending
, popular
, watched
, played
, URL
(trakt list).
-
Watched Lists: Shows that are the most watched by unique Trakt users (mutliple viewings excluded).
-
watched
/watched_weekly
- Most watched in the week. -
watched_monthly
- Most watched in the month. -
watched_yearly
- Most watched in the year. -
watched_all
- Most watched of all time.
-
-
Played Lists: Shows that are the most played by Trakt users (mutliple viewings included).
-
played
/played_weekly
- Most played in the week. -
played_monthly
- Most played in the month. -
played_yearly
- Most played in the year. -
played_all
Most played of all time.
-
-l
, --add-limit
- Limit number of shows added to Sonarr.
-d
, --add-delay
- Add seconds delay between each add request to Sonarr. Default is 2.5 seconds.
- Example:
-d 5
-s
, --sort
- Sort list by highest votes
, highest rating
, or the latest release
dates. Default is highest votes
.
- Example:
-s release
-g
, --genre
- Only add shows from this genre to Sonarr.
- Can find a list here.
-f
, --folder
- Add shows to a specific root folder in Sonarr.
- Example:
-f /mnt/unionfs/Media/Shows/Shows-Kids/
--no-search
- Tells Sonarr to not automatically search for added shows.
--notifications
- To enable notifications. Default is disabled
.
--ignore-blacklist
- Ignores blacklist filtering. Equivalent of disabled_for
in config.json.
Examples (CLI)
Movies
-
Add the movie "Black Panther (2018)":
traktarr movie -id black-panther-2018
-
Add movies, from the popular list, labeled with the thriller genre, limited to 5 items, and sorted by latest release date.
traktarr movies -t popular -g thriller -l 5 -s release
-
Add movies, from the boxoffice list, labeled with the comedy genre, limited to 10 items, and send notifications:
traktarr movies -t boxoffice -g comedy -l 10 --notifications
-
Add movies, from a list of most watched played this week, and limited to 5 items.
traktarr movies -t watched -l 5
-
Add movies, from a list of most played movies this month, and limited to 5 items.
traktarr movies -t played_monthly -l 5
-
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
-
Add (all) movies from the private list
https://trakt.tv/users/user1/lists/private-movies-list
ofuser1
:traktarr movies -t https://trakt.tv/users/user1/lists/private-movies-list --authenticate-user=user1
Shows
-
Add the show "The 100":
traktarr show -id the-100
-
Add shows, from the popular list, limited to 5 items, and sorted by higest ratings.
traktarr shows -t popular -l 5 -s rating
-
Add shows, from the popular list, limited to 2 items, and don't start automatic for them in Sonarr:
traktarr shows -t popular -l 2 --no-search
-
Add shows, from a list of most watched shows this year, and limited to 5 items.
traktarr shows -t watched_yearly -l 5
-
Add shows, from a list of most played shows this week, and limited to 5 items.
traktarr shows -t played -l 5
-
Add shows, from a list of most played shows of all time, and limited to 5 items.
traktarr shows -t played_all -l 5
-
Add (all) shows from the watchlist of
user1
:traktarr shows -t watchlist --authenticate-user user1