Misc scripts and tools. Undocumented scripts probably do what I need them to but aren't finished yet.
See the top-level README for setup instructions.
All these scripts use the same .env and requirements.
TMDB_KEY=TMDB_API_KEY # https://developers.themoviedb.org/3/getting-started/introduction
TVDB_KEY=TVDB_V4_API_KEY # currently not used; https://thetvdb.com/api-information
PLEX_URL=https://plex.domain.tld # URL for Plex; can be a domain or IP:PORT
PLEX_TOKEN=PLEX-TOKEN
PLEX_OWNER=yournamehere # account name of the server owner
LIBRARY_NAMES=Movies,TV Shows,Movies 4K # comma-separated list of libraries to act on
CAST_DEPTH=20 # how deep to go into the cast for actor collections
TOP_COUNT=10 # how many actors to export
TARGET_LABELS=this label, that label # comma-separated list of labels to remove posters from
REMOVE_LABELS=True # attempt to remove the TARGET_LABELs from items after resetting the poster
DELAY=1 # optional delay between items
POSTER_DIR=extracted_posters # put downloaded posters here
POSTER_DEPTH=20 # grab this many posters [0 grabs all]
POSTER_DOWNLOAD=0 # if set to 0, generate a script rather than downloading
POSTER_CONSOLIDATE=1 # if set to 0, posters are separated into folders by library
KOMETA_CONFIG_DIR=/opt/kometa/Kometa/config/ # path to Kometa config directory
# ORIGINAL TO ASSETS
USE_ASSET_FOLDERS=1 # should the asset directory use asset folders?
ASSETS_BY_LIBRARIES=1 # should those asset folders be sorted into library folders?
ASSET_DIR=assets # top-level directory for those assets
- clean-overlay-backup.py - clean out leftover overlay backup art
- extract-collections.py - extract collections from a library
- overlay-default-posters.py - apply overlays to default collection posters
- kometa-trakt-auth.py - generate trakt auth block for Kometa config.yml
- kometa-mal-auth.py - generate mal auth block for Kometa config.yml
- original-to-assets.py - Copy image files from an "Original Posters" directory to an asset directory
- metadata-extractor.py - Extract all metadata from libraries into a Kometa-compatible metadata YAML file
- top-n-actor-coll.py - generate collections for the top n actors in a library
You've deleted stuff from Plex and want to clean up the leftover backup art that Kometa saved when it applied overlays
The script uses these settings from the .env:
PLEX_URL=https://plex.domain.tld # URL for Plex; can be a domain or IP:PORT
PLEX_TOKEN=PLEX-TOKEN
LIBRARY_NAMES=Movies,TV Shows,Movies 4K # comma-separated list of libraries to act on
DELAY=1 # optional delay between items
KOMETA_CONFIG_DIR=/opt/kometa/config/ # path to Kometa config directory
- setup as above
- Run with
python clean-overlay-backup.py
The script will catalog the backup files and current Plex contents for each library listed in the .env.
It then compares the two lists, and any files in the backup dir that do not correspond to current items in Plkex are deleted.
Starting clean-overlay-backup 0.1.0 at 2024-02-13 17:52:31
connecting to https://plex.bing.bang...
6686 images in the Movies overlay backup directory ...
Loading Movies ...
Loading movies from Movies ...
Completed loading 6965 of 6965 movie(s) from Movies
Clean Overlay Backup Movies |████████████████████████████████████████| 6965/6965 [100%] in 11.0s (633.23/s)
Processed 6965 of 6965
0 items to delete
279 items in Plex with no backup art
These might be items added to Plex since the last overlay run
They might be items that are not intended to have overlays
...
You're getting started with Kometa and you want to export your existing collections
Here is a quick and dirty [emphasis on "quick" and "dirty"] way to do that.
- setup as above
- Run with
python extract-collections.py
The script will grab some details from each collection and write a metadata file that you could use with Kometa. It also grabs artwork and background.
This is extremely naive; it doesn't recreate filters, just grabs a list of everything in each collection.
For example, you'll end up with something like this for each collection:
collections:
ABC:
sort_title: +++_ABC
url_poster: ./config/TV Shows - 4K-artwork/ABC.png
summary: A collection of ABC content
collection_order: release
plex_search:
any:
title:
- Twin Peaks
- Strange World
- Designated Survivor
- The Good DoctorYou want to apply an overlay to the default collection posters; perhaps for branding, perhaps you don't like the separators, whatever
Here is a basic script to do that.
- setup as above
- create overlay images in
default_collection_overlays[see README in that folder for notes.] - Run with
overlay-default-posters.py
The script will clone or update the Kometa-Images repo, then iterate through it applying overlays to each image and storing them in a parallel file system rooted at Kometa-Images-Overlaid, ready for you to use with the Kometa Asset Directory [after moving them to that directory] or via template variables.
It chooses the overlay by name based on the "group" that each collection is part of:
Kometa-Images
├── aspect
├── audio_language
├── award
├── based
├── chart
├── content_rating
├── country
├── decade
├── franchise
├── genre
├── network
├── playlist
├── resolution
├── seasonal
├── separators
├── streaming
├── studio
├── subtitle_language
├── universe
└── year
For example, all the audio_language collection posters will be overlaid by Kometa/default_collection_overlays/audio_language.png.
If there isn't a specific image for a "group", then Kometa/default_collection_overlays/overlay-template.png will be used.
Fetch/Pull on Kometa-Images
Using default_collection_overlays/overlay-template.png as global overlay
building list of targets
Applying overlays |████████████████████████████▎ | ▇▅▃ 5027/7119 [71%] in 3:53 (21.6/s, eta: 1:37)
Kometa-Images/genre/Sword & Sandal.jpg
Perhaps you're running Kometa in a docker or something where getting it into interactive mode to authentication trakt is a hassle.
This little script will generate the trakt section for your Kometa config file. Most of this code is pulled from Kometa's own trakt authentication; it's just been simplified to do the one thing.
You can run this on a completely separate machine to where Kometa is running.
There is an online version available here.
- Run with
python kometa-trakt-auth.py
You'll be asked for your trakt Client ID and Client Secret then taken to a trakt web page.
Copy the PIN and paste it at the prompt.
Some yaml will be printed, ready to copy-paste into your Kometa config.yml.
Let's authenticate against Trakt!
Trakt Client ID: JOHNNYJOEYDEEDEE
Trakt Client Secret: PETEROGERJOHNKEITH
Taking you to: https://trakt.tv/oauth/authorize?response_type=code&client_id=JOHNNYJOEYDEEDEE&redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob
If you get an OAuth error your Client ID or Client Secret is invalid
If a browser window doesn't open go to that URL manually.
Enter the Trakt pin from that web page: 9CE4045E
Copy the following into your Kometa config.yml:
############################################
trakt:
client_id: JOHNNYJOEYDEEDEE
client_secret: PETEROGERJOHNKEITH
authorization:
access_token: OZZYTONYGEEZERBILL
token_type: Bearer
expires_in: 7889237
refresh_token: JOHNPAULGEORGERINGO
scope: public
created_at: 1644589166
############################################
This little script will generate the mal section for your Kometa config file. Most of this code is pulled from Kometa's own MAL authentication; it's just been simplified to do the one thing.
You can run this on a completely separate machine to where Kometa is running.
There is an online version available here.
python3 -m pip install pyopensslpython3 -m pip install requests secrets- Run it with
python3 kometa-mal-auth.py.
You'll be asked for your MyAnimeList Client ID and Client Secret then taken to a MyAnimeList web page.
Log in and click "Allow"; you'll be redirected to a localhost page that won't load.
Copy that localhost URL and paste it at the prompt.
Some yaml will be printed, ready to copy-paste into your Kometa config.yml.
Let's authenticate against MyAnimeList!
MyAnimeList Client ID: JOHNNYJOEYDEEDEE
MyAnimeList Client Secret: PETEROGERJOHNKEITH
We're going to open https://myanimelist.net/v1/oauth2/authorize?response_type=code&client_id=JOHNNYJOEYDEEDEE&code_challenge=STINGANDYSTEWART
Log in and click the Allow option.
You will be redirected to a localhost url that probably won't load.
That's fine. Copy that localhost URL and paste it below.
Hit enter when ready:
URL: http://localhost/?code=TuomasEmppuTroyFloorKaiJukka
Copy the following into your Kometa config.yml:
############################################
mal:
client_id: JOHNNYJOEYDEEDEE
client_secret: PETEROGERJOHNKEITH
authorization:
access_token: OZZYTONYGEEZERBILL
token_type: Bearer
expires_in: 2415600
refresh_token: JOHNPAULGEORGERINGO
############################################
You've applied overlays to a library and want to seed an asset directory with the "Original Posters".
Here is a basic script to do that.
- setup as above
- Run with
original-to-assets.py
The script will copy the contents of the "Original Posters" directory to an asset directory.
Note, this will only copy images that have received overlays, and for which the rating keys in Plex are matching.
If you don't have overlays on any episodes, this script will not put any episode images in the asset directory, and so on.
# ORIGINAL TO ASSETS
USE_ASSET_FOLDERS=1 # should the asset directory use asset folders?
ASSET_DIR=assets # top-level directory for those assets
The asset file system will be rooted at the directory in the ASSET_DIR setting, and USE_ASSET_FOLDERS controls whether the images are stored as:
USE_ASSET_FOLDERS=1
Media-Scripts/Plex/assets/All That Jazz (1979) {imdb-tt0078754} {tmdb-16858}.jpg
or USE_ASSET_FOLDERS=0
Media-Scripts/Plex/assets/All That Jazz (1979) {imdb-tt0078754} {tmdb-16858}/poster.jpg
example output:
Starting originals-to-assets 0.0.1 at 2024-04-01 17:13:30
connecting to https://test-plex.DOMAIN.TLD...
Loading Test-Movies ...
Loading movies ...
Completed loading 35 of 35 movie(s) from Test-Movies
Grab all posters Test-Movies |████████████████████████████████████████| 35/35 [100%] in 0.2s (190.63/s)
Processed 35 of 35
Complete!
You want to seed a Kometa metadata file with the contents of one or more libraries.
Here is a basic script to do that.
- setup as above
- Run with
metadata-extractor.py
The script will read all metadata from one of more libraries and format it into a Kometa-compatible metadata file. This includes current artwork, which will be downloaded and the files linked in the metadata YAML.
IMPORTANT NOTES:
This script backs up all Kometa-supported metadata [with a few minor exceptions], which includes things you may not have changed. It also includes the "Overlay" label. It backs up this label because it also backsup the current art, which might be overlaid. You will probably want to edit or trim this file before using it to restore.
Metadata not backed up:
metadata_language Movie, Show
subtitle mode Show, Season
content_rating Episode
Generally these are because it's not obvious how to extract them from Plex and I haven't reviewed the Kometa source to see what it sets in these cases, OR the values in Plex differ from the values in Kometa and I haven't looked into why.
The match method defaults to IMDb ID, falls back to TMDB/TVDB if here is no IMDb ID, and if neither exist, uses title and year. The edition [value or blank] is added for movies in any case.
example output:
Starting metadata-extractor 0.2.0 at 2024-08-16 21:20:27
connecting to http://192.168.1.11:32400...
tmdb config...
getting items from [Kometa-Demo-Movies]...
looping over 218 items...
Extracting metadata from Kometa-Demo-Movies |████████████████████████████████████████| 218/218 [100%] in 9:17.8 (0.39/s)
getting items from [Kometa-Demo-TV]...
looping over 24 items...
Extracting metadata from Kometa-Demo-TV |████████████████████████████████████████| 24/24 [100%] in 1:21.6 (0.29/s)
processed 242 items in 642.92 seconds.
That run produced two metadata files:
metadata-Kometa-Demo-Movies.yml
metadata-Kometa-Demo-TV.yml
And a directory of images:
metadata-items
├── Kometa-Demo-Movies
│ ├── imdb-tt0031381-378
│ │ ├── background.jpg
│ │ └── poster.jpg
│ ├── imdb-tt0031679-584
│ │ ├── background.jpg
│ │ └── poster.jpg
│ ├── imdb-tt0035575-1238
│ │ ├── background.jpg
...
This has been obsoleted by "Dynamic Collections" in Kometa; it's left here for historical reference.
You should use Dynamic Collections instead.
Connects to a plex library, grabs all the movies.
For each movie, gets the cast from TMDB; keeps track across all movies how many times it sees each actor. You can specify a TV library, but I haven't tested that a lot. My one attempt showed a list of 10 actors who had each been in 1 series, which doesn't seem right.
At the end, builds a basic Kometa metadata file for the top N actors.
Script-specific variables in .env:
CAST_DEPTH=20 ### HOW DEEP TO GO INTO EACH MOVIE CAST
TOP_COUNT=10 ### PUT THIS MANY INTO THE FILE AT THE END
CAST_DEPTH is meant to prevent some journeyman character actor from showing up in the top ten; I'm thinking of someone like Clint Howard who's been in the cast of many movies, but I'm guessing when you think of the top ten actors in your library you're not thinking about Clint. Maybe you are, though, in which case set that higher.
TOP_COUNT is the number of actors to dump into the metadata file at the end.
template.tmpl - this is the beginning of the target metadata file; change it if you like, but you're on your own there.
collection.tmpl - this is the collection definition inserted for each actor [%%NAME%%% and %%ID%% are placeholders that get substituted for each actor]; change it if you like, but this script only knows about those two data field substitutions.
- setup as above
- Run with
python top-n-actor-coll.py
connecting...
getting movies...
looping over 2819 movies...
[==--------------------------------------] 5.4% ... Annihilation
It will go through all your movies, and then at the end print out however many actors you specified in TOP_COUNT and produce a yml file.
38 2231-Samuel L. Jackson
26 500-Tom Cruise
25 64-Gary Oldman
25 192-Morgan Freeman
23 884-Steve Buscemi
22 62-Bruce Willis
22 31-Tom Hanks
21 19278-Bill Hader
21 2888-Will Smith
21 16483-Sylvester Stallone
In my 4K movie library, the script produces:
######################################################
# People Collections #
######################################################
templates:
Person:
smart_filter:
any:
actor: tmdb
director: tmdb
writer: tmdb
producer: tmdb
sort_by: year.asc
validate: false
tmdb_person: <<person>>
sort_title: +9_<<collection_name>>
schedule: weekly(monday)
collection_order: release
collection_mode: hide
collections:
Samuel L. Jackson:
template: {name: Person, person: 2231}
Tom Cruise:
template: {name: Person, person: 500}
Gary Oldman:
template: {name: Person, person: 64}
Morgan Freeman:
template: {name: Person, person: 192}
Steve Buscemi:
template: {name: Person, person: 884}
Bruce Willis:
template: {name: Person, person: 62}
Tom Hanks:
template: {name: Person, person: 31}
Bill Hader:
template: {name: Person, person: 19278}
Will Smith:
template: {name: Person, person: 2888}
Sylvester Stallone:
template: {name: Person, person: 16483}