https://github.com/valknight/DoesTheDogWatchPlex

DoesTheDogDie.com + Plex Integration
https://github.com/valknight/DoesTheDogWatchPlex

Last synced: 5 days ago
JSON representation

DoesTheDogDie.com + Plex Integration

• Host: GitHub
• URL: https://github.com/valknight/DoesTheDogWatchPlex
• Owner: valknight
• License: mit
• Created: 2019-05-12T01:25:29.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-14T10:06:49.000Z (about 5 years ago)
• Last Synced: 2024-08-01T22:02:26.541Z (3 months ago)
• Language: Python
• Size: 6.43 MB
• Stars: 37
• Watchers: 4
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DoesTheDogWatchPlex

> An integration of DoesTheDogDie.com and Plex Media Server

![Demonstration of DoesTheDogWatchPlex using Marvel's Infinity War](/screenshots/1.png)

## What does this do?

This modifies the summaries of movies to contain content warnings from DoesTheDogDie.com.

## Why?

Some of the people using my Plex server (myself included) sometimes go through rough patches, and don't want to stumble into a movie that happens to contain something like, a pet dying, sexual assault, or other things. However, alt-tabbing to DoesTheDogDie.com can get tiresome, so this exists, meaning you can see brief previews of the data from DoesTheDogDie.com without ever leaving the Plex interface.

## What is the web API?

To speed up requests, a web API wrapper can be used - this is so that, if many different versions of this app are hitting the same API, only one request will need to hit the original DTDD, without having all the different versions have access to the memcache. It also means other tools that wish to use DTDD can also call upon the API, whether that be a proper Plex agent, or some other tool for you Jellyfin weirdos.

I recommend you use the API that is set in the example config (dtdd.valknight.xyz), as that means the more users there are, the more likely your requested media is to be cached, however, if you are privacy conscious, you can setup your own, or avoid the web API solution altogether.

## How to get started (CLI tools)

0. Install python 3.4+ and create a virtual environment for this

1. Execute `pip install -r requirements.txt`

2. Copy config.py.example to config.py, and fill out the data with what is relevant to your setup

3. Execute `python build_json.py`, and sit back and wait for the movies.json file to be generated 

4. Once this file is generated, check over it, and **make a Plex Media Server database backup** (from this point on, all metadata changes will be permanent to your server)

5. Run `python write_to_plex.py`

To update the content warnings, run build_json.py again, and then write_to_plex.py - anything below the line reading `doesthedogdie: ` will simply be removed, and replaced with the new updated content warnings (anything above shouldn't be touched)

## How to get started (DTDD web API wrapper)

This will run the server in a debug mode. For production, please look up the recommended way to run a Flask app in production for your platform and requirements.

0. Install python 3.4+ and create a virtual environment for this

Recommended: setup memcache - this will greatly improve performance

1. Execute `pip install -r requirements.txt`

2. Copy config.py.example to config.py, and fill out the data with what is relevant to your setup

3. Run `python dtdd_apip.py`

## Plans

- TV series support

- Moving to an agent instead of this hacky setup

- Customizing splitter between the actual summary and content warnings

## LICENSE

This project is licensed under the MIT license.