Asset-Assistant: A Python repository from mikenobbs

Asset-Assistant (AA) is a simple python script designed to categorise, move and rename artwork for your personal media server. Add 1000's of images without the need to manually drag and drop them into individual directories, giving you more time to actually enjoy your media.

The script is designed primarily to use images from The Poster Database (TPDb) and MediUX as they use a straightforward naming scheme of Title (year), which should align with naming of your media folders. The script then compares the filename with the directory name and starts the moving and renaming process. For Movies/Shows/Collections, both posters and backgrounds are supported, with the images being dynamically renamed based on their dimensions. Season and episode renaming is dependent on the service you are using.

Tip

Using Sonarr/Radarr combined with TRaSH Guides will give you the best possible outcome, as the script was written with TRaSH's naming convention in mind.

Important

One of the main points of failure is going to be collection assets. This is partly down to the loose way in which they are detected, but mainly the issue is going to be any discrepencies between what you've called your collections and what they're called on TPDb/MediUX. Fortunately, failed assets are moved to a separate directory for you to either rename and try again, or move manually 🙂

Features

Supports a range of naming schemes for popular services:
- Emby (coming soon)
- Jellyfin (coming soon)
- Kodi (coming soon)
- Kometa
- Plex
Supports posters and backgrounds for Movies, Shows and Collections
Supports season posters and episode cards for Shows
Full logging to track which assets are moving where
All asset categories tracked and counted
Failed assets are backed up to be reviewed at a later time
Optional backup for all successful moves
Optional Discord webhook notification support

Getting Started

Installation

After downloading/cloning the repo, unzip the file to see this directory structure:

Asset-Assistant-main
├── asset-assistant.py
├── config.yml
├── LICENSE
├── logo
│   ├── logo.png
│   └── logomark.png
├── modules
│   ├── logs.py
│   └── notifications.py
├── README.md
├── requirements.txt
└── VERSION

Open a terminal/CMD window in this directory and install requirements.txt

pip install -r requirements.txt

Config Variables

To use this script you will need to edit the following variables in your config.yml file

process: Directory for all your downloaded assets (emptied after every run)

movies: Directory that your movie assets will be moved to

shows: Directory where your show assets will be moved to

collections: Directory where your collection assets will be moved to

enable_backup: (Optional) true or false, false by default

service: (Optional) the service that you use

plex_specials: (Plex users only, required) Plex specials directory naming, true or false, true = Specials, false = Season 00

discord_webhook: (Optional) Discord webhook URL for notifications after every run

Important

All directories (process/movies/shows/collections) must be unique for the script to function properly. For Kodi, this guide here outlines the collection directory process, which you'll want to point AA at. For Kometa, you may need to adjust your setup slightly in order to achieve the separate directories. Below is an example of how to achieve this:

libraries:
  Movies:
    collection_files:
      - file: config/movies1.yml
        asset_directory: config/assets/collections
      - file: config/movies2.yml
        asset_directory: config/assets/collections
    settings:
      asset_directory: config/assets/movies
  TV Shows:
    collection_files:
      - repo: config/tv1.yml
        asset_directory: config/assets/collections
      - repo: config/tv2.yml
        asset_directory: config/assets/collections
    settings:
      asset_directory: config/assets/tv

Notice that while the main asset directory for each library is movies/tv, I specify that each collection yml is actually pointing at config/assets/collections.

Note

While optional, setting the service variable greatly expands the functionality of AA. Depending on which service you use, this setting unlocks the ability to move and rename season posters and episode cards, and even collection assets. Without it you will be limited to just movie and show assets. Please note that currently only Kodi and Kometa support collection assets unfortunately. This is due to the other services not directly supporting local assets for collections.

Warning

All assets will be removed from process after each run. In case of any incorrect moves I highly recommend using enable_backup: true.

Deployment

From the script directory, run

  python asset-assistant.py

to start AA.

Roadmap

Additional media server support
Add support for .zip files
Add more notifications options

Disclaimer

I'm not a Python guy, heck I'm not even a coder, so take care when using this script. I tried to test every possible combination of variables but there's always a chance I missed something. I also personally only use Plex which I manage with Kometa, and while I did research the other supported services, I'm not as well versed on the ins and outs of them. As such, PRs are more than welcome, and if you have any issues at all feel free to post either an Issue, or come and find me in the TPDb Discord Server, DMs welcome and I'm always around 🙂

Tip

As an extra precaution I'd recommend either setting up some dummy directories to test AA out for yourself, or running it with just a small amount of images (eg. a single show/movie/collection). This should give you a feel for how it works and let you tweak the variables if needed before unleashing it onto your entire library.