Skip to content

jokerigno/pingrr

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Check out traktarr https://github.com/l3uddz/traktarr for a cool alternative if pingrr isn't for you

alt text

pingrr.

Python script that checks certain lists on Trakt and Netflix's recently added shows/movies, as well as JustWatch's recent shows/movies and if they meet your configured filters, adds them to your sonarr/radarr library.

Currently supports:

  1. Trakt Trending
  2. Trakt Anticipated
  3. Trakt Popular
  4. Netflix recently added # Currently not supported, use justwatch
  5. Just Watch recently added

Getting Started

You will need a trakt.tv account with a Trakt API key, as well as your Sonarr API.

Quick warning when setting up the script. If you activate lots of lists with no filters, you will get a lot of shows that you may not want. At a minimum, it is recommended to use the language code filter and limit shows added per run.

Prerequisites

You will need a Trakt account and an API key (client ID), you can create a new API app in trakt here

  1. Python 2.7
  2. requests
  3. BeautifulSoup
  4. fuzzywuzzy
  5. ImdbPY

sudo apt-get install python

pip install -r requirements.txt

Installing

git clone https://github.com/Dec64/pingrr.git

cd pingrr

python pingrr.py

Follow the instructions in the console to complete the configuration file. This is only needed on the first run. Once complete you will need to re-run Pingrr.

python pingrr.py

If you intend to leave it running, it would be best to use systemd startup or screen.

screen -S pingrr python pingrr.py

Check it's all running fine by tailing the log

tail -f logs/pingrr.log

Command line arguments

If you want to define a config location for pingrr (running multiple instances with different categories/folder locations/lists) you can define the config location via:

  • Command line by using -c or --config=:

    • python pingrr.py -c /my/config/location/conf.json
    • python pingrr.py --config=/my/config/location/conf.json
  • Environment variable by setting PINGRR_CONFIG:

    • PINGRR_CONFIG=/my/config/location/conf.json python pingrr.py

Logging level can be increased if you are having issues and want more output in the log/console by using --loglevel:

  • python pingrr.py --loglevel=DEBUG

To list all possible arguments and options run:

  • python pingrr.py -h

Blacklist

There is a blacklist.json file created on the first run. This file will have failed shows and any show you want to add to it outside of filters that you never want to add. To add a show, either use the shows IMDB id or TVDB id.

{"blacklist": ["imdb id", "or tvdb id", "332493", "75760", "79168", "334069"]}

Just Watch

https://www.justwatch.com/

Early support for justwatch is included.

    "just_watch": {
        "enabled": true,
        "country": "GB",
        "pages": "1"
    }

Each page is a single day, so if you set 1 page, it will check against all services justwatch supports in your chosen country for the last day.

Set more pages to scan back more days, doing this will cause the scan to take longer and potentially add a lot of shows.

Should support any two-letter country code that Just Watch has data for.

E.g:

Germany
Austria
Switzerland
United Kingdom
Ireland
Russia
Italy
France
Spain
Netherlands
Norway
Sweden
Denmark
Finland
Lithuania
Latvia
Estonia
USA
Canada
Mexico

and more

Config

There are a few config settings that are not set by the user on the first run if you fancy messing with more advanced settings you can open up the config.json file and change as needed.

Please see below for an explanation for the current config

{
    "allflicks": {
        "enabled": {
            "movies": true,
            "shows": false
        },
        "rating_match": 94
    },
    "filters": {
        "allow_canceled": true, ## allow shows that are cancelled to be added
        "allow_ended": true, ## allow shows that are finished to be added
        "country": ["gb","us","ca"], ## What countrys shows/movies are allowed to be from (whitelist)
        "genre": [], ## What genres shows/movies are NOT allowed to be from (blacklist)
        "language": "en", ## What language is allowed for shows/movies (whitelist)
        "network": "YouTube", ## What networks to NOT allow (blacklist)
        "rating": 3, ## Min rating show/movie must have to be added
        "runtime": 0, ## Min runtime show/movie must have to be added
        "votes": 1, ## Min votes show/movie must have to be added
        "year": {
            "movies": 0, ## Min year movie must be to be added
            "shows": 0 ## Min year show must be to be added
        }
    },
    "pingrr": {
        "limit": {
            "sonarr": 0, ## Amount of shows to be added per cycle
            "radarr": 0 ## Amount of movies to be added per cycle
        },
        "log_level": "info", ## Log level for pingrr
        "timer": 1.00, ## How long to wait, in hours, untill next scan
        "aired": 10 ## If show has less episodes then this aired, do not count towards limit
        "dry_run": False ## Set to true to not add any shows, just test filter results
    },
    "pushover": {
        "app_token": "",
        "enabled": true,
        "user_token": ""
    },
    "slack": {
        "channel": "",
        "enabled": false,
        "sender_icon": ":robot_face:",
        "sender_name": "Pingrr",
        "webhook_url": ""
    },
    "sonarr": {
        "api": "",
        "folder_path": "/mnt/media/TV/", ## Default root folder path shows will be sent to
        "quality_profile": 1, ## Quality profile ID to assign to show in sonarr
        "monitored": true, ## Add show monitored or not
        "search_missing_episodes": true, ## Search for missing episodes on add or not
        "genre_paths": true, ## Use genre paths, change folder path for show depending on catagory
        "path_root": "/mnt/media/", ## Root of the path. Only need if using genre paths
        "paths": {  ## "Kids-TV": [children] == /mnt/media/Kids-TV for any show with genre "children". Add more as needed. Resolves in order. If show is Anime, will be sent to anime before Kids-TV in this example.
            "Anime": [
            "anime"
        ],
            "Kids-TV": [
            "children"
        ],
            "Travel-TV": [
            "documentary"
        ],
            "Reality-TV": [
            "reality",
                "game-show"
        ]
        }
    },
        "radarr": {
        "api": "",
        "folder_path": "/mnt/media/Movies/",
        "host": "http://localhost:7878",
        "quality_profile": 1,
        "monitored": true,
        "genre_paths": true,
        "path_root": "/mnt/media/",
        "paths": {
            "Anime": [
            "anime"
        ],
            "Kids-TV": [
            "children"
        ],
            "Travel-TV": [
            "documentary"
        ],
            "Reality-TV": [
            "reality",
                "game-show"
        ]
        }
    },
    "trakt": {
        "api": "", ## Client ID from trakt
        "imdb_info": false, ## Use imdb info for votes/genres/vote count if possible instead of trakt. WARNING, MUCH SLOWER THEN TRAKT.
        "limit": 2000, ## Max shows trakt will return. Use a higher number, e.g. 1000 to return a lot.
        "tv_list": {
            "anticipated": false,  ## Enable trakt tv anticipated
            "popular": false,	## Enable trakt tv popular
            "trending": false	## Enable trakt tv trending
        },
        "movie_list": {
            "anticipated": true, ## Enable trakt movie anticipated
            "popular": true, ## Enable trakt movie popular
            "trending": true ## Enable trakt movie trending
        }
    },
    "just_watch": {
        "enabled": {
            "movies": true, ## Enable justwatch for movies
            "shows": false ## Enable justwatch for shows
        },
        "country": "GB", ## What country to get justwatch info based on, e.g. GB or US
        "pages": "20" ## How many pages to get info from, 1 page = 1 day. Add more pages to add more content. Will be slower with more pages
    }
}
"rating_match":94

How close the match has to be out of 100 when parsing Netflix titles. If you feel you are missing some titles feel free to play with this figure, but anything lower then 90 will most likely result in incorrect matches.

For the unwanted genres list, you need to type them as found on IMDB, here are some examples:

comedy
action
drama
fantasy
science-fiction
adventure
reality
superhero
crime
mystery
horror
thriller
romance
animation
children
home-and-garden
anime
family
documentary
game-show
suspense

Start on boot

To have pingrr start on boot on Ubuntu

cd /opt

git clone https://github.com/Dec64/pingrr.git

run pingrr, and complete the config.

sudo nano /etc/systemd/system/pingrr.service

copy and paste the below, after editing User= and Group=

[Unit]
Description=pingrr
After=network-online.target

[Service]
User=YOUR_USER
Group=YOUR_USER
Type=simple
WorkingDirectory=/opt/pingrr/
ExecStart=/usr/bin/python /opt/pingrr/pingrr.py
Restart=always
RestartSec=10

[Install]
WantedBy=default.target

Then enabled and start it with:

sudo systemctl enable pingrr.service

sudo systemctl start pingrr


If you are have set pingrr to not loop (setting the timer to 0) then you must remove Restart=always RestartSec=10 from systemd file, otherwise, it will restart every 10 seconds.

Todo

  1. Learn python

Thanks

Thanks to horjulf and l3uddz for assisting me with a few bits so far, and everyone that helped test it along the way.

If you have any suggestions for features ect feel free to create a new issue on GitHub for it!

Donate

If you absolutely feel the need to donate, the link is below. Pull requests and help cleaning up my amateur python would be more helpful :)

paypal

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.4%
  • Dockerfile 1.6%