Traktarr uses Trakt.tv to find shows and movies to add in to Sonarr and Radarr, respectively.

Go to file

James 9d476288a0 Merge branch 'develop' * develop: only change type_name when authenticate user is supplied		7 years ago
assets	Readme: Added Demo.gif	7 years ago
docker	Something important	7 years ago
helpers	improved genre unblacklist & check when -g is supplied.	7 years ago
media	only change type_name when authenticate user is supplied	7 years ago
misc	added allowed_countries to config	7 years ago
notifications	use debug log level for sent notification messages	7 years ago
systemd	remove unionfs.service from After sevice file entry	7 years ago
.dockerignore	Fix docker cloud build	7 years ago
.gitignore	ignore venv folder	7 years ago
LICENSE	Create LICENSE	7 years ago
README.md	Readme: fix tabs	7 years ago
requirements.txt	Bump requirements	7 years ago
traktarr.py	increase version	7 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
Public lists
Private lists*
- Watchlist
- Custom list(s)

* Support for multiple (authenticated) users.

traktarr
Demo
Requirements
Installation
Configuration
- Sample Configuration
- Core
- Automatic
  - Personal Watchlists
  - Custom Lists
    - Public Lists
    - Private Lists
- Filters
  - Movies
  - Shows
- Notifications
  - Pushover
  - Slack
- Radarr
- Sonarr
  - Tags
- Trakt
Usage

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 (run id 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 the Redirect uri field.
Click "SAVE APP".
Open the traktarr configuration file config.json and insert the Client ID in the client_id and the Client Secret in the client_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": {
      "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": {
      "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": ""
    },
    "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 - show debug messages.

Default is false (keep it off unless your having issues).

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 (i.e. via manual/CLI command only); see Usage.

"automatic": {
  "movies": {
    "anticipated": 3,
    "boxoffice": 10,
    "interval": 24,
    "popular": 3,
    "trending": 2,
    "watchlist": {},
    "lists": {}
  },
  "shows": {
    "anticipated": 10,
    "interval": 48,
    "popular": 1,
    "trending": 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.

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": {
    "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": []
  },

allowed_countries - only add movies from these countries.

allowed_languages - only add movies with these languages (default/blank=English).

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.)

blacklist_title_keywords - blacklist certain words in titles.

blacklisted_genres - blacklist certain genres.

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": []
}

allowed_countries - only add shows from these countries.

allowed_languages - only add shows with these languages (default/blank=English).

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.

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": ""
  },
  "slack": {
    "service": "slack",
    "webhook_url": ""
  },
  "verbose": true
},

verbose - toggle detailed notifications.

Default is true (keep it off unless your having issues).

Pushover

app_token and user_token - retrieve from Pushover.net.

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.

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 Scret)

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.
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:

  -d, --add-delay FLOAT  Seconds between each add request to Sonarr / Radarr.
                         [default: 2.5]
  --no-search            Disable search when adding to Sonarr / Radarr.
  --run-now              Do a first run immediately without waiting.
  --no-notifications     Disable notifications.
  --help                 Show this message and exit.

You can bring up the list, anytime, by running the following command:

traktarr run --help

* Remember, other configuration options need to go into the config.json file under the Automatic section.

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, 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]
  -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.
  --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.