diff --git a/README.md b/README.md index 457dc22..c273fc3 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,10 @@ [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4J6RPWZ9J9YML) [![PM](https://img.shields.io/badge/Reddit-Message-lightgrey.svg)](https://www.reddit.com/user/Blacktwin/) [![PM](https://img.shields.io/badge/Plex-Message-orange.svg)](https://forums.plex.tv/profile/discussions/Blacktwin) [![Issue](https://img.shields.io/badge/Submit-Issue-red.svg)](https://github.com/blacktwin/JBOPS/issues/new) -Most of these scripts utilize a combination of [PlexPy](https://github.com/JonnyWong16/plexpy), [python-plexapi](https://github.com/pkkid/python-plexapi), and [requests](http://docs.python-requests.org/en/master/user/install/#install). +Most of these scripts utilize a combination of [Tautulli](https://github.com/Tautulli/Tautulli), [python-plexapi](https://github.com/pkkid/python-plexapi), and [requests](http://docs.python-requests.org/en/master/user/install/#install). + +## Notice: +These scripts have not been tested using Tautulli. The improvements in Tautulli may cause errors with scripts that pull data from Tautulli, especailly metadata. If you come into a problem please create an issue and reference the script that errors out with Tautulli. Once Tautulli is out of Beta I'll look into which scripts need updated and which can be removed. ## Scripts List [![Gist](https://img.shields.io/badge/gist-Blacktwin-green.svg)](https://gist.github.com/blacktwin) @@ -25,7 +28,7 @@ Scripts pulled from my gist profile. Maps - Using PlexPy data, draw a map connecting Server to Clients based on IP addresses. + Using Tautulli data, draw a map connecting Server to Clients based on IP addresses. @@ -66,8 +69,8 @@ Scripts pulled from my gist profile. wait_kill_pause_notify_main - Receive session_key from PlexPy when paused. Use sub-script wait_kill_pause_notify_sub - to wait for X time then check if still paused. If so, kill. Toggle whether you'd like to be notified through a PlexPy notification agent. + Receive session_key from Tautulli when paused. Use sub-script wait_kill_pause_notify_sub + to wait for X time then check if still paused. If so, kill. Toggle whether you'd like to be notified through a Tautulli notification agent. @@ -94,7 +97,7 @@ Scripts pulled from my gist profile. ip_whitelist - Receive session_key and IP from PlexPy when playback starts. Use IP to check against whitelist. If not in whitelist use session_key to determine stream and kill. + Receive session_key and IP from Tautulli when playback starts. Use IP to check against whitelist. If not in whitelist use session_key to determine stream and kill. @@ -104,7 +107,7 @@ Scripts pulled from my gist profile. kill_else_if_buffering - Kill concurrent transcode streams of other users if Admin user is experiencing buffering warnings from PlexPy. + Kill concurrent transcode streams of other users if Admin user is experiencing buffering warnings from Tautulli. @@ -134,7 +137,7 @@ Scripts pulled from my gist profile. kill_trans_pause - Kill Plex paused video transcoding streams using PlexPy. + Kill Plex paused video transcoding streams using Tautulli. @@ -157,12 +160,12 @@ Scripts pulled from my gist profile. find_unwatched_notify - Find what was added TFRAME ago and not watched and notify admin using PlexPy. + Find what was added TFRAME ago and not watched and notify admin using Tautulli. notify_added_custom - Send an email with what was added to Plex in the past week using PlexPy. Email includes title (TV: Show Name: Episode Name; Movie: Movie Title), time added, image, and summary. + Send an email with what was added to Plex in the past week using Tautulli. Email includes title (TV: Show Name: Episode Name; Movie: Movie Title), time added, image, and summary. @@ -220,7 +223,7 @@ Scripts pulled from my gist profile. bypass_auth_name - Use PlexPy to pull last IP address from user and add to List of IP addresses and networks that are allowed without auth in Plex. + Use Tautulli to pull last IP address from user and add to List of IP addresses and networks that are allowed without auth in Plex. @@ -235,7 +238,7 @@ Scripts pulled from my gist profile. find_unwatched - Find what was added TFRAME ago and not watched using PlexPy. + Find what was added TFRAME ago and not watched using Tautulli. @@ -302,7 +305,7 @@ Scripts pulled from my gist profile. added_to_plex - Find when media was added between STARTFRAME and ENDFRAME to Plex through PlexPy. + Find when media was added between STARTFRAME and ENDFRAME to Plex through Tautulli. @@ -317,12 +320,12 @@ Scripts pulled from my gist profile. drive_check - Check if drive exists. If not then notify via PlexPy notifier agent. + Check if drive exists. If not then notify via Tautulli notifier agent. userplays_weekly_reporting - Use PlexPy to count how many plays per user occurred this week and send email via PlexPy. + Use Tautulli to count how many plays per user occurred this week and send email via Tautulli. @@ -331,9 +334,9 @@ Scripts pulled from my gist profile. ----
-Setting Up PlexPy for Custom Scripts +Setting Up Tautulli for Custom Scripts -#### Enabling Scripts in PlexPy: +#### Enabling Scripts in Tautulli: Settings > Notification Agents > Click the Scripts gear @@ -364,14 +367,14 @@ Settings > Notifications > Click Script - [ ] PLEX_HOST - Local IP to connect to Plex ('localhost', '192.168.0.x', '127.0.0.1', etc.) - [ ] PLEX_PORT - Port number used by Plex (default: 32400) - [ ] PLEX_SSL - http:// or https://? '' if http and 's' if https -- [ ] PLEX_TOKEN - [Plex](https://support.plex.tv/hc/en-us/articles/204059436-Finding-an-authentication-token-X-Plex-Token) or PlexPy Settings > Plex.tv Account > PMS Token +- [ ] PLEX_TOKEN - [Plex](https://support.plex.tv/hc/en-us/articles/204059436-Finding-an-authentication-token-X-Plex-Token) or Tautulli Settings > Plex.tv Account > PMS Token
-PlexPy +Tautulli -- [ ] PLEXPY_URL - Local IP to connect to PlexPy ('localhost', '192.168.0.x', '127.0.0.1', etc.) -- [ ] PLEXPY_APIKEY - PlexPy Settings > Access Control > Enable API - API Key +- [ ] TAUTULLI_URL - Local IP to connect to Tautulli ('localhost', '192.168.0.x', '127.0.0.1', etc.) +- [ ] TAUTULLI_APIKEY - Tautulli Settings > Access Control > Enable API - API Key