Plexer

Summary

A CLI tool made to make organizing your media for Plex Media Server easy. Normalize names of media files and directories to match the hierarchial requirements that Plex requires.

Features

Support

Currently, Plexer only supports organizing movies and other individual video files.

Roadmap

• Support for TV Shows (#28)
• Docker implementations (#29)
• MacOS support (#30)
• Windows support (#31)
• Metadata inference using file/directory info (i.e. analyze the video files to "guess" what the name, year, etc is) (#32)

Install

Docker

The most portable way to install and run Plexer is by using Docker.

Via Container Registry

The easiest way to run Plexer in Docker is by using the public containers hosted on container registries. Plexer images are available on both Docker Hub and GitHub Container Registry. See the commands below for how to run Plexer using each registry.

Docker Hub

docker run --rm -it magneticstain/plexer-cli

Github Container Registry

docker run --rm -it ghcr.io/magneticstain/plexer-cli

Via Local Image Build

In the case that container registries are unavailable, there's also the option to build the image locally. To do that, check out the main branch of this repo, build the Plexer image, and run it.

git clone https://github.com/magneticstain/plexer-cli.git
docker build -t plexer_cli .
docker run --rm -it plexer_cli

Requirements

Linux and MacOS Native Install

If you've installed plexer-cli natively (i.e. outside of a Docker container) on Ubuntu, Devian, Fedora, etc, or MacOS, you will also need to install additional dependencies:

Python-Magic

While python-magic is imported in the standard fashion (via pip/python requirements), it itself depends on the presence of the libmagic C library. To install this library, follow the installation instructions provided in the python-magic README.

Media Metadata

The most important requirement before running plexer is to ensure that you've created a .plexer file in each of your target directories.

This is a JSON-formatted file that includes the movie metadata required by Plexer to perform its jobs.

Usage

The source directory is the directory containing the raw media. The destination is where you'd like to save the processed media to.

usage: plexer.py [-h] [-v] [--version] -s SOURCE_DIR -d DESTINATION_DIR

options:
  -h, --help            show this help message and exit
  -v, --verbose         Verbosity (-v, -vv, etc)
  --version             show program's version number and exit
  -s SOURCE_DIR, --source-dir SOURCE_DIR
  -d DESTINATION_DIR, --destination-dir DESTINATION_DIR

Support & Feedback

If you run into issues while using Plexer, think you know a way to make it better, or just need help using it, create a new issue within this project and they will triaged when possible.

Development

Software Stack

For developing with Plexer, there are several tools that are in use:

1. Build Backend, Packaging, and Dependency Management:
   1. Hatch
2. Analysis Tools:
   1. Ruff
3. Testing:
   1. Pytest
   2. Tox

Coding Standards and Conventions

• Pre-commit hooks are utilized and managed in .pre-commit-config.yml
  • For example, ruff is run as part of every commit
  • These pre-commit hooks MUST be installed and utilized by all developers

Testing

• All functions MUST have unit tests created for them
• Tests are executed using VS Code with the launch.json config file in .vscode