370 lines
17 KiB
Markdown
370 lines
17 KiB
Markdown
|
|
# JBOPS - Just a Bunch Of Plex Scripts
|
|
|
|
|
|
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).
|
|
|
|
For use of config.ini for common variables please use [plexapi.CONFIG](http://python-plexapi.readthedocs.io/en/latest/configuration.html)
|
|
|
|
Default location `~/.config/plexapi/config.ini`
|
|
```python
|
|
# To find path
|
|
import plexapi
|
|
print(plexapi.CONFIG_PATH)
|
|
```
|
|
|
|
### Contact
|
|
[](https://discord.gg/tQcWEUp) [](https://www.reddit.com/user/Blacktwin/) [](https://forums.plex.tv/u/blacktwin) [](https://github.com/blacktwin/JBOPS/issues/new)
|
|
|
|
### Donation
|
|
<a href="https://www.paypal.me/Adam581/1" target=blank><img src=http://imgur.com/WSVZSTW.png alt="Buy Me a Coffee" height=50 width=100 align='center'>
|
|
</a> or <a href="https://www.paypal.me/Adam581/3" target=blank><img src=http://imgur.com/gnvlm6n.jpg alt="Buy Me a Beer" height=50 width=100 align='center'></a>
|
|
|
|
<details>
|
|
<summary>Coins?</summary>
|
|
<details>
|
|
<summary>BTC:</summary>
|
|
3FCb4F3bv1hHCJxq6HJMQiAMn883v3okdh
|
|
</details>
|
|
|
|
<details>
|
|
<summary>BCH:</summary>
|
|
qr758vkn7nv6hx0ur9m2tlv8q4qjrvg6pg3yw4kzwq
|
|
</details>
|
|
|
|
<details>
|
|
<summary>ETH:</summary>
|
|
0xa76c8EB9A4955023F0dAABfb32FCD2b460910F2b
|
|
</details>
|
|
|
|
<details>
|
|
<summary>LTC:</summary>
|
|
MCw3r6rC8jNCcUvSMSu9EqQyyvEDp8EpEf
|
|
</details>
|
|
</details>
|
|
|
|
## Scripts List
|
|
[](https://gist.github.com/blacktwin)
|
|
|
|
Scripts pulled from my gist profile.
|
|
|
|
<details>
|
|
<summary><a href="https://github.com/blacktwin/JBOPS/tree/master/maps">Maps</a></summary>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Example</th>
|
|
<th>File</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://github.com/blacktwin/JBOPS/raw/master/maps/EU_map_example.PNG"><img src="https://img.shields.io/badge/Image-EU_map-blue.svg" alt=""</a>
|
|
<a href="https://github.com/blacktwin/JBOPS/raw/master/maps/NA_map_example.PNG"><img src="https://img.shields.io/badge/Image-NA_map-blue.svg" alt=""</a>
|
|
<a href="https://github.com/blacktwin/JBOPS/raw/master/maps/World_map_example.PNG"><img src="https://img.shields.io/badge/Image-World_map-blue.svg" alt=""</a>
|
|
<a href="https://github.com/blacktwin/JBOPS/blob/master/maps/geojson_example.geojson"><img src="https://img.shields.io/badge/Image-geojson-blue.svg" alt=""</a></td>
|
|
<td><a href="../master/maps/ips_to_maps.py"ips_to_maps>Maps</a></td>
|
|
<td>Using Tautulli data, draw a map connecting Server to Clients based on IP addresses.</td>
|
|
</tr>
|
|
</table>
|
|
</details>
|
|
|
|
<details>
|
|
<summary><a href="https://github.com/blacktwin/JBOPS/tree/master/fun">Fun</a></summary>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Gist</th>
|
|
<th>File</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="../master/fun/playlist_manager.py">playlist_manager</a></td>
|
|
<td>Create and share playlists based on Most Popular TV/Movies from Tautulli and Aired this day in history.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/4ccb79c7d01a95176b8e88bf4890cd2b"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/fun/plexapi_haiku.py">plexapi_haiku</a></td>
|
|
<td>Create a hiaku from titles found in Plex.</td>
|
|
</tr>
|
|
</table>
|
|
</details>
|
|
|
|
|
|
<details>
|
|
<summary><a href="https://github.com/blacktwin/JBOPS/tree/master/killstream">Kill stream</a>
|
|
</summary>
|
|
<b>
|
|
Killing streams is a Plex Pass feature. These scripts will only work for Plex Pass users.
|
|
</b>
|
|
<table>
|
|
<tr>
|
|
<th>Gist</th>
|
|
<th>File</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="../master/killstream/limiterr.py">limiterr</a></td>
|
|
<td>Limiting Plex users by plays, watches, or total time from Tautulli..
|
|
See killsteam section <a href="../master/killstream/limiterr_readme.md">limiterr_readme.md</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="../master/killstream/kill_stream.py">kill_stream</a></td>
|
|
<td>Use Conditions, Arguements, and Parameters to kill a Plex stream.
|
|
See killsteam section <a href="../master/killstream/readme.md">readme.md</a></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</details>
|
|
|
|
|
|
<details>
|
|
<summary><a href="https://github.com/blacktwin/JBOPS/tree/master/notify">Notify</a></summary>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Gist</th>
|
|
<th>File</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="../master/notify/notify_delay.py">notify_delay</a></td>
|
|
<td>Delay Notification Agent message for concurrent streams.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/e6d589a9af9bdf168717951083861e93"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/notify/find_unwatched_notify.py">find_unwatched_notify</a></td>
|
|
<td>Find what was added TFRAME ago and not watched and notify admin using Tautulli.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/1094dcf38249f36c8d374e0cba7a86cd"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/notify/notify_added_custom.py">notify_added_custom</a></td>
|
|
<td>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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/099c07d8099c18a378bba6415d9253ba"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/notify/notify_fav_tv_all_movie.py">notify_fav_tv_all_movie</a></td>
|
|
<td>Notify users of recently added episode to show that they have watched at least LIMIT times via email. Also notify users of new movies.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/a2d4b2f2c3b616f1d6da0752fecb2ae7"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/notify/notify_newip.py">notify_newip</a></td>
|
|
<td>If a new IP is found send notification via the Email Notification Agent. Email contains User's Avatar image, link to location, IP address, and User's Email address.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/a327055da54d7feb3eef10e64a8b661a"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/notify/notify_on_added.py">notify_on_added</a></td>
|
|
<td>Send an Email notification when a specific show is added to Plex. Add shows to list that you want notifications for.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/18960ff01c03b67a05594daa6f53660c"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/notify/notify_user_favorites.py">notify_user_favorites</a></td>
|
|
<td>Notify users of recently added episode to show that they have watched at least LIMIT times via email.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/066c66328a795ebd6079a575e14f0b8b"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/notify/notify_user_newip.py">notify_user_newip</a></td>
|
|
<td>Notify user that their account has been accessed by a new IP. IP is cleared to make sure notification is sent again.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/261c416dbed08291e6d12f6987d9bafa"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/notify/twitter_notify.py">twitter_notify</a></td>
|
|
<td>Post to Twitter when TV/Movie is added to Plex. Include custom message and embed poster image. Option to tweet to TWITTER_USER if title is inside TITLE_FIND.</td>
|
|
</tr>
|
|
</table>
|
|
</details>
|
|
|
|
|
|
<details>
|
|
<summary><a href="https://github.com/blacktwin/JBOPS/tree/master/utility">Utility</a></summary>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Gist</th>
|
|
<th>File</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="../master/utility/plex_api_parental_control.py">plex_api_parental_control</a></td>
|
|
<td>Set as cron or task for times of allowing and not allowing user access to server. Unsharing will kill any current stream from user before unsharing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="../master/utility/plex_api_share.py">plex_api_share</a></td>
|
|
<td>Share or unshare libraries</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/f4149c296f2d1ffd1cbd863c37bb3a3c"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/bypass_auth_name.py">bypass_auth_name</a></td>
|
|
<td>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. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/0332f2dc9534bdf412ff3f664e9513c0"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/delete_watched_TV.py">delete_watched_TV</a></td>
|
|
<td>From a list of TV shows, check if users in a list has watched shows episodes. If all users in list have watched an episode of listed show, then delete episode. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/76b0abf88181618af4598092dd6b0dbb"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/find_plex_meta.py">find_plex_meta</a></td>
|
|
<td>Find location of Plex metadata. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/603d5da5b70b366e98d0d82d1aa1a470"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/find_unwatched.py">find_unwatched</a></td>
|
|
<td>Find what was added TFRAME ago and not watched using Tautulli. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/f435aa0ccd498b0840d2407d599bf31d"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/grab_gdrive_media.py">grab_gdrive_media</a></td>
|
|
<td>Grab media (videos, pictures) from Google Drive. All videos and pictures were automatically synced from Google Photos to Google Drive. Puts media into MEDIA_TYPE/YEAR/MONTH-DAY/FILE.ext directory structure. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/85a63ffd70c6ccb7c1faa70a8f33fc2e"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/plex_api_poster_pull.py">plex_api_poster_pull</a></td>
|
|
<td>Pull Movie and TV Show poster images from Plex. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/17b58156f69cc52026b71fe4d5afea05"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/plex_imgur_dl.py">plex_imgur_dl</a></td>
|
|
<td>Pull poster images from Imgur and places them inside Shows root folder. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/f10e0a1e85af00e878963b4570a99054"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/plex_theme_songs.py">plex_theme_songs</a></td>
|
|
<td>Download theme songs from Plex TV Shows. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/45c420cbba4e18aadc8cc5090a67b9d1"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/plexapi_delete_playlists.py">plexapi_delete_playlists</a></td>
|
|
<td>Delete all playlists from Plex using PlexAPI. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/3752a76fa0b3fc6d19e842af7b812184"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/refresh_next_episode.py">refresh_next_episode</a></td>
|
|
<td>Refresh the next episode of show once current episode is watched. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/370ca42ee20a33fb00c8253fa9bd0de7"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/remove_watched_movies.py">remove_watched_movies</a></td>
|
|
<td>Find Movies that have been watched by a list of users. If all users have watched movie then delete. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/2f619e62d99edcec27f680998379664c"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/utility/stream_limiter_ban_email.py">stream_limiter_ban_email</a></td>
|
|
<td>This is indented to restrict a user to the LIMIT amount of concurrent streams. User will be warned, punished, and banned completely if violations continue.</td>
|
|
</tr>
|
|
</table>
|
|
</details>
|
|
|
|
<details>
|
|
<summary><a href="https://github.com/blacktwin/JBOPS/tree/master/reporting">Reporting</a></summary>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Gist</th>
|
|
<th>File</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="../master/reporting/weekly_stats_reporting.py">weekly_stats_reporting</a></td>
|
|
<td>Pull library and user statistics of last week.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/21823b3394f5b077d42495b21570b593"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/reporting/added_to_plex.py">added_to_plex</a></td>
|
|
<td>Find when media was added between STARTFRAME and ENDFRAME to Plex through Tautulli.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/f070dff29ddbeb87973be9c0a94a1df7"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/reporting/check_play.py">check_play</a></td>
|
|
<td>Check if user has play a file more than 3 times but has not finished watching. Hoping to catch play failures. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/1a8933252ad1a9bc2c97395a020c144a"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/reporting/check_plex_log.py">check_plex_log</a></td>
|
|
<td>Checking plex logs for debug code WARN and 'Failed to obtain a streaming resource for transcode of key /library/metadata/"titleID"'. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/561c3a404754eb7b9e543867619d3251"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/reporting/drive_check.py">drive_check</a></td>
|
|
<td>Check if drive exists. If not then notify via Tautulli notifier agent. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://gist.github.com/blacktwin/bd905d39ab71c5d7c628e27fddd1086e"><img src="https://img.shields.io/badge/gist-original-green.svg"></a></td>
|
|
<td><a href="../master/reporting/userplays_weekly_reporting.py">userplays_weekly_reporting</a></td>
|
|
<td>Use Tautulli to count how many plays per user occurred this week and send email via Tautulli.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</details>
|
|
|
|
----
|
|
### Setting Up Tautulli for Custom Scripts
|
|
<details>
|
|
<summary></summary>
|
|
|
|
#### Enable API in Tautulli:
|
|
|
|
Tautulli > Settings > Web Interface > API > Enable API
|
|
|
|
|
|
#### Enabling Scripts in Tautulli:
|
|
|
|
Tautulli > Settings > Notification Agents > Add a Notification Agent > Script
|
|
|
|
#### Configuration
|
|
|
|
Tautulli > Settings > Notification Agents > New Script > Configuration:
|
|
- [ ] Set scripts location to location of your script
|
|
- [ ] Scroll down to option you want to use and select the script from the drop down menu
|
|
- [ ] Set desired Script Timeout value
|
|
- [ ] Optional - Add a description of the script for easy reference
|
|
- [ ] Save
|
|
|
|
#### Triggers
|
|
Tautulli > Settings > Notification Agents > New Script > Triggers:
|
|
|
|
- [ ] Check desired trigger
|
|
- [ ] Save
|
|
|
|
#### Conditions
|
|
Tautulli > Settings > Notification Agents > New Script > Conditions:
|
|
|
|
- [ ] Set desired conditions
|
|
- [ ] Save
|
|
|
|
For more information on Tautulli conditions see [here](https://github.com/Tautulli/Tautulli/wiki/Custom-Notification-Conditions)
|
|
|
|
#### Script Arguments
|
|
Tautulli > Settings > Notification Agents > New Script > Script Arguments:
|
|
|
|
- [ ] Select desired trigger
|
|
- [ ] Input desired notification parameters (List of parameters will likely be found inside script)
|
|
- [ ] Save
|
|
- [ ] Close
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
### Common variables
|
|
|
|
<details>
|
|
<summary>Plex</summary>
|
|
|
|
- [ ] PLEX_URL - Local/Remote IP to connect to Plex ('http://localhost:32400', 'https://x.x.x.x:32412', etc.)
|
|
- [ ] 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
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Tautulli</summary>
|
|
|
|
- [ ] TAUTULLI_URL - Local/Remote IP to connect to Tautulli ('http://localhost:8181', 'https://x.x.x.x:8182', etc.)
|
|
- [ ] TAUTULLI_APIKEY - Tautulli Settings > Access Control > Enable API - API Key
|
|
</details>
|