@ -19,6 +19,13 @@ The specific steps you will be taking:
1. use `docker` to run the image
2. use a text editor to modify a couple of text files until you have a working config file and a single working metadata file.
Note that running a Docker container is inherently a pretty technical process. If you are unable or unwilling to learn the rudiments of using Docker, this may not be the tool for you.
If the idea of editing YAML files by hand is daunting, this may not be the tool for you. All the configuration of PMM is done via YAML text files, so if you are unable or unwilling to learn how those work, you should stop here.
Finally, this walkthrough is intended to give you a basic grounding in how to get the script running. It doesn't cover how to create your own collections, or how to add overlays, or any of the myriad other things PMM is capable of. It provides a simple "Getting Started" guide for those for whom the standard install instructions make no sense; presumably because you've never run a Docker container before.
## Prerequisites.
Anywhere you see
@ -62,12 +69,13 @@ This message shows that your installation appears to be working correctly.
...
```
If that doesn't work, stop here until you fix that. Diagnoing and repairing Docker install problems is out of the scope of this walkthrough.
---
#### Important note on Docker images
This tutorial uses the official image, and you should, too. Don't change `meisnate12/plex-meta-manager` to the `linuxserver.io` image or any other; the lsio image specifically has [idiosyncracies](alternative-docker.md) that will prevent this walkthrough from working. The official image *will* behave exactly as documented below. Other very possibly won't.
This tutorial uses the official image, and you should, too. Don't change `meisnate12/plex-meta-manager` to the `linuxserver.io` image or any other; the lsio image specifically has [idiosyncracies](alternative-docker.md) that will prevent this walkthrough from working. The official image *will* behave exactly as documented below. Others very possibly won't.
The great thing about Docker is that all the setup you'd have to do to run PMM is already done inside the docker image.
@ -113,11 +121,12 @@ cd ~
mkdir plex-meta-manager
```
cd into that directory:
cd into that directory and create another directory:
[type this into your terminal]
```
cd ~/plex-meta-manager
mkdir config
```
get the full path:
@ -128,427 +137,217 @@ pwd
```
This will display a full path:
<details>
<summary>OS X</summary>
<br/>
````{tab} Linux
<br/>
```
/Users/YOURUSERNAME/plex-meta-manager
/home/YOURUSERNAME/plex-meta-manager
```
</details>
<details>
<summary>Linux</summary>
<br/>
````
````{tab} OS X:
<br/>
```
/home/YOURUSERNAME/plex-meta-manager
/Users/YOURUSERNAME/plex-meta-manager
```
</details>
<details>
<summary>Windows</summary>
<br/>
````
````{tab} Windows:
<br/>
```
C:\Users\YOURUSERNAME\plex-meta-manager
```
</details>
You'll need to add this to the docker command every time you run it, like this:
<br/>
````
Add "config" onto the end of that to get the host path to your config directory, for example:
<details>
<summary>Linux</summary>
````{tab} Linux
<br/>
```
docker run --rm -it -v "/home/YOURUSERNAME/plex-meta-manager:/config:rw" meisnate12/plex-meta-manager
/home/YOURUSERNAME/plex-meta-manager/config
```
</details>
<details>
<summary>Windows</summary>
<br/>
````
````{tab} OS X:
<br/>
```
docker run --rm -it -v "C:\Users\YOURUSERNAME\plex-meta-manager:/config:rw" meisnate12/plex-meta-manager
/Users/YOURUSERNAME/plex-meta-manager/config
```
</details>
If you run that command now it will display a similar error to before, but without all the image loading:
<br/>
````
````{tab} Windows:
<br/>
```
$ docker run --rm -it -v "/Users/mroche/plex-meta-manager:/config:rw" meisnate12/plex-meta-manager --run
Config Error: config not found at //config
C:\Users\YOURUSERNAME\plex-meta-manager\config
```
<br/>
````
Note that I show the example path there.
### Setting up the initial config file
Next you’ll set up the config file. ThIs tells PMM how to connect to Plex and a variety of other services.
Before you do this you’ll need:
1. TMDb API key. They’re free.
1. Plex URL and Token
There are a bunch of other services you *can* configure in the config file, but these two are the bare minimum.
#### Getting a TMDb API Key
Note that if you already have an API key, you can use that one. You don’t need another.
Go to https://www.themoviedb.org/. Log into your account [or create one if you don’t have one already], then go to “Settings” under your account menu.
In the sidebar menu on the left, select “API”.
Click to generate a new API key under "Request an API Key". If there is already one there, copy it and go to the next step.
There will be a form to fill out; the answers are arbitrary. The URL can be your personal website, or probably even google.com or the like.
Once you’ve done that there should be an API Key available on this screen.
Copy that value, you’ll need it for the config file.
#### Getting a Plex URL and Token
The Plex URL is whatever URL you’d use **from this machine** to connect directly to your Plex server [i.e. NOT app.plex.tv].
As with the TMDb API Key, if you already have a Plex Token, you can use that one.
This article will describe how to get a token: [Finding an authentication token](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/)
#### Editing the config template
First, make a copy of the template, then open the copy in an editor:
You'll need to add this to the docker command every time you run it, like this:
<details>
<summary>OS X/Linux</summary>
````{tab} Linux
<br/>
Get a copy of the template to edit [type this into your terminal]:
docker run --rm -it -v "/home/YOURUSERNAME/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager
```
Open it in an editor [type this into your terminal]:
<br/>
````
````{tab} OS X:
<br/>
```
nano config.yml
docker run --rm -it -v "/Users/YOURUSERNAME/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager
```
I’m using `nano` here simply because it’s built into OSX. On Linux you may need to install `nano`, or you can use any other text editor you wish provided it saves files as PLAIN TEXT.
</details>
<details>
<summary>Windows</summary>
<br/>
Download the file `https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/config/config.yml.template` using a web browser or whatever means and save it in this directory as `config.yml`
[type this into your terminal]
````
````{tab} Windows:
<br/>
```
notepad config.yml
docker run --rm -it -v "C:\Users\YOURUSERNAME\plex-meta-manager\config:/config:rw" meisnate12/plex-meta-manager
```
I’m using `notepad` here simply because it’s built into Windows. You can use any other text editor provided it saves files as PLAIN TEXT.
</details>
From here on in, when I say "open the config file", I mean the `nano` or `notepad` command. You don't want to download the template again.
---
Scroll down a bit and update the three things you just collected; Plex URL, Plex Token, and TMDb API Key.
```yaml
plex: # Can be individually specified per library as well
## This file is a template remove the .template to use the file
If you run that command now it will display a similar error to before, but without all the image loading:
libraries: # This is called out once within the config.yml file
Movies: # Each library must match the Plex library name
metadata_path:
- file: config/Movies.yml # This is a local file on the system
- folder: config/Movies/ # This is a local directory on the system
- git: meisnate12/MovieCharts # This is a file within the GitHub Repository
TV Shows:
metadata_path:
- file: config/TVShows.yml
- folder: config/TV Shows/
- git: meisnate12/ShowCharts # This points to the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
Anime:
metadata_path:
- file: config/Anime.yml
Music:
metadata_path:
- file: config/Music.yml
```
You will ultimately need an entry here for each of the libraries on which you want PMM to act. Those top-level elements [Movies, TV Shows, Anime, Music] are names of libraries on your Plex server.
For now, delete the “TV Shows”, “Anime”, and "Music" sections and change the name of the “Movies” section to “Movies-NOSUCHLIBRARY":
```yaml
libraries:
Movies-NOSUCHLIBRARY: ## <<<CHANGETHISLINE
metadata_path:
- file: config/Movies.yml
- git: meisnate12/MovieCharts
$ docker run --rm -it -v "/Users/mroche/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager --run
Config Error: config not found at //config
```
This is intended to cause an error.
#### Testing the config file
Save the file:
Note that I show the example path there.
<details>
<summary>OS X/Linux</summary>
<summary>Why did we create that `config' directory?</summary>
<br/>
If you're using `nano`, type control-`x`, then `y`, then the enter key.
This was done so that from here on in the instructions match between this walkthrough and the [Local walkthrough](local) are the same.
</details>
<details>
<summary>Windows</summary>
<br/>
If you're using `notepad`, type alt-`s` or choose `Save` from the `File` menu.
### Create a directory to quiet an error later
</details>
The default config file contains a reference to a directory that will show an error in the output later. That error can safely be ignored, but it causes some confusion with new users from time to time.
Then run the script again:
We'll create it here so the error doesn't show up later.
````{tab} Linux
<br/>
[type this into your terminal]
```
docker run --rm -it -v "PMM_PATH_GOES_HERE:/config:rw" meisnate12/plex-meta-manager --run
```
I’ve removed some of the lines for space, but have left the important bits:
```
...
| Starting Run|
...
| Locating config...
|
| Using /Users/mroche/Plex-Meta-Manager/config/config.yml as config
...
| Connecting to TMDb...
| TMDb Connection Successful
...
| Connecting to Plex Libraries...
...
| Connecting to Movies-NOSUCHLIBRARY Library... |
...
| Plex Error: Plex Library Movies-NOSUCHLIBRARY not found |
| Plex Error: No Plex libraries were connected to |
...
```
You can see there that PMM found its config file, was able to connect to TMDb, was able to connect to Plex, and then failed trying to read the “Movies-NOSUCHLIBRARY library, which of course doesn’t exist.
Open the config file again and change "Movies-NOSUCHLIBRARY" to reflect your Plex. Then delete any lines that start with “git”. Those are all sets of collections, and we just want to create a few as examples.
My Movies library is called “Main Movies", so mine looks like this:
```yaml
libraries:
Main Movies: ## <<<CHANGETHISLINE
metadata_path:
- file: config/Movies.yml
mkdir config/assets
```
Save the file:
<details>
<summary>OS X/Linux</summary>
<br/>
If you're using `nano`, type control-`x`, then `y`, then the enter key.
</details>
<details>
<summary>Windows</summary>
````
````{tab} OS X:
<br/>
If you're using `notepad`, type alt-`s` of choose `Save` from the `File` menu.
</details>
Then run the script again:
[type this into your terminal]
```
docker run --rm -it -v "PMM_PATH_GOES_HERE:/config:rw" meisnate12/plex-meta-manager --run
mkdir config/assets
```
Now you’ll see some more activity in the Plex connection section:
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
```
$ docker run --rm -it -v "/Users/mroche/plex-meta-manager:/config:rw" meisnate12/plex-meta-manager --run
...
| Connecting to Plex Libraries...
...
| Connecting to Main Movies Library...
...
| Loading Metadata File: config/Movies.yml
|
| YAML Error: File Error: File does not exist config/Movies.yml
...
| Metadata File Error: No valid metadata files found
|
| Main Movies Library Connection Failed
...
mkdir config\assets
```
<br/>
````
PMM may start cataloging your movies at this point; you cna hit control-C to stop that if it's happening.
We can see there that it connected to the Plex Library but failed to find that `Movies.yml` metadata file.
So far so good.
### Setting up a metadata file and creating a few sample collections.
Now we have to set up that metadata file that PMM just complained about.
### Setting up the initial config file
This metadata file contains definitions of the actions you want PMM to take; these can be things like creating collections or playlists, adding overlays, changing things like posters, etc. You can find lots of examples [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs) and throughout the wiki.
```{include} wt/wt-01.md
```
For now we’re going to create a few collections so you can watch the process work, then you’re on your own to create whatever others you want.
#### Editing the config template
First, open the metadata file [this will create the file if it doesn't already exist]:
First, make a copy of the template:
<details>
<summary>OS X/Linux</summary>
````{tab} Linux
<br/>
[type this into your terminal]
Get a copy of the template to edit [type this into your terminal]:
I chose a letterboxd list for the last one since trakt requires authentication and again, I didn’t want to complicate this walkthrough.
This is going to create three collections. One contains movies that feature Bill Murray. One is up to 100 movies that came out in the 1980s sorted by popularity. The last are movies that appear on a list of good endings according to Vulture.
The first one is based on a template to illustrate that concept. If you wanted to create a collection for another actor you just have to copy and edit those two lines [the ID comes from TMDb]. All the other config details come from the template.
Save the file:
<details>
<summary>OS X/Linux</summary>
````
````{tab} Windows:
<br/>
Go to [this URL](https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/config/config.yml.template) using a web browser; choose the "Save" command, then save the file at:
If you're using `nano`, type control-`x`, then `y`, then the enter key.
If you're using `notepad`, type alt-`s` of choose `Save` from the `File` menu.
```{include} wt/wt-02.md
```
</details>
#### Testing the config file
Then run the script again:
Save the file:
[type this into your terminal]
```
docker run --rm -it -v "PMM_PATH_GOES_HERE:/config:rw" meisnate12/plex-meta-manager --run
```{include} wt/wt-save.md
```
This time you should see that the metadata file gets loaded:
Then run the script again:
```
| Loading Metadata File: config/Movies.yml
| Metadata File Loaded Successfully
```{include} wt/wt-run-docker.md
```
And this time it will catalog all your movies. This could take a while depending on how many movies are in that library.
```{include} wt/wt-03.md
```
Once this mapping is complete it will move on to build those three collections.
Save the file:
As it builds the collections, you should see a fair amount of logging about which movies are being added and which ones aren’t found. Once it completes, go to Plex, go to your Movies library, and click “Collections” at the top.
```{include} wt/wt-save.md
```
You should see the three new collections:
Then run the script again:
```{include} wt/wt-run-docker.md
```
When you click into each, you’ll see the movies that PMM added to each collection.
```{include} wt/wt-04.md
```
Each time you run the script, new movies that match the collection definition will be added. For example, if you don’t have “The Razors’ Edge” now, when you download it and run PMM again it will be added to the Bill Murray collection.
### Setting up a metadata file and creating a few sample collections.
If you download any of the missing 22 movies on the Vulture list, running PMM would add them to that collection. And so on.
```{include} wt/wt-05.md
```
### What comes next:
Save the file:
Delete these three collections if you want, from both Plex and the metadata file [`config/Movies.yml`].
```{include} wt/wt-save.md
```
Edit `Movies.yml` to reflect the actions you want PMM to perform on *your* libraries.
Then run the script again:
TV Shows and other libraries work the same way as you've seen above. Create a section under `Libraries:` in the config.yml, create a metadata file, define collections, run the script.
```{include} wt/wt-run-docker.md
```
Investigate the rest of the wiki to learn about everything Plex-Meta-Manager can do for you.
@ -19,6 +19,12 @@ The specific steps you will be taking:
1. use `python` to run the script
2. use a text editor to modify a couple of text files until you have a working config file and a single working metadata file.
Note that running a Python script is inherently a pretty technical process. If you are unable or unwilling to learn the rudiments of using tools like python and git, you should probably strongly consider running PMM in [Docker](docker). That will eliminate the Python and git installs from this process and make it as simple as it can be.
If the idea of editing YAML files by hand is daunting, this may not be the tool for you. All the configuration of PMM is done via YAML text files, so if you are unable or unwilling to learn how those work, you should stop here.
Finally, this walkthrough is intended to give you a basic grounding in how to get the script running. It doesn't cover how to create your own collections, or how to add overlays, or any of the myriad other things PMM is capable of. It provides a simple "Getting Started" guide for those for whom the standard install instructions make no sense; presumably because you've never run a Python script before.
## Prerequisites.
Nearly anywhere you see
@ -43,28 +49,24 @@ This walkthrough is assuming you are doing the entire process on the same platfo
Since most of this is typing commands into a terminal, you'll need to have a terminal open.
<details>
<summary>Linux</summary>
````{tab} Linux
<br/>
If your Linux system is remote to your computer, connect to it via SSH. That SSH session is the terminal you will be using, so leave it open.
If you are running this on a desktop Linux machine, start up the Terminal application. That window will be the terminal you will type commands into, so leave it open.
</details>
<details>
<summary>OS X</summary>
If you are running this on a desktop Linux machine, start up the Terminal application. That window will be the terminal you will type commands into throughout this walkthrough, so leave it open.
<br/>
Open the Terminal app; this window will be the place you type commands, so leave it open. THe Terminal app is in Applications -> Utilities.
You can also use iTerm or some other terminal app if you wish. If you don't know what that is, use Terminal.
</details>
````
````{tab} OS X:
Open the Terminal app; this window will be the place you type commands throughout this walkthrough, so leave it open. The Terminal app is in Applications -> Utilities.
<details>
<summary>Windows</summary>
You can also use iTerm or some other terminal app if you wish. If you don't know what that means, use Terminal.
<br/>
Use the Start menu to open PowerShell. This will be the window into which you type commands, so leave it open.
</details>
````
````{tab} Windows:
Use the Start menu to open PowerShell. This will be the window into which you type commands throughout this walkthrough, so leave it open.
<br/>
````
### Installing Python.
@ -78,28 +80,23 @@ python3 --version
If this doesn't return `3.7.0` or higher, you'll need to get Python 3 installed.
<details>
<summary>Linux</summary>
````{tab} Linux
<br/>
Describing a python install for any arbitrary linux is out of scope here, but if you're using Ubuntu, [this](https://techviewleo.com/how-to-install-python-on-ubuntu-linux/) might be useful.
</details>
<details>
<summary>OS X</summary>
<br/>
````
````{tab} OS X:
Follow the instructions here: [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/)
</details>
<details>
<summary>Windows</summary>
<br/>
````
````{tab} Windows:
Go to http://www.python.org/download and download the latest version of Python for Windows in 32 or 64-bit as appropriate for your system [probably 64-bit]. As this is written, that's 3.10.4.
Once downloaded, run the installer. Tick “Add to path” checkbox at the bottom and click “Install Now”.
For Windows 10, you will need to enable scripts in PowerShell. Follow the instructions [here](https://windowsloop.com/enable-powershell-scripts-execution-windows-10) to do so. If you skip this step you're going to hit a hard stop in a little bit.
</details>
<br/>
````
---
@ -115,25 +112,18 @@ git --version
If this doesn't return a version number, you'll need to get git installed.
<details>
<summary>Linux</summary>
````{tab} Linux
<br/>
The git install is discussed here: [Download for Linux and Unix](https://git-scm.com/download/linux)
</details>
<details>
<summary>OS X</summary>
<br/>
````
````{tab} OS X:
<br/>
The git install is discussed here: [Git - Downloading Package](https://git-scm.com/download/mac)
</details>
<details>
<summary>Windows</summary>
<br/>
````
````{tab} Windows:
<br/>
Download the installer from [here](https://git-scm.com/download/windows)
Run the install; you can probably just accept the defaults and click through except for the step that asks you to choose an editor; you probably want to choose something other than the default there:
@ -141,8 +131,8 @@ If this doesn't return a version number, you'll need to get git installed.
This install comes with its own command line interface. **Do not use this interface in this walkthrough**. Continue to do everything here in Powershell.
</details>
<br/>
````
---
@ -216,8 +206,7 @@ Later on you can move it elsewhere if you want, but for now put it there. This
This walkthrough is going to use a "virtual environment", since that provides a simple way to keep the requirements for a given thing self-contained; think of it as a "sandbox" for this script. It also provides a clean way to recover from mistakes, and keeps the host system clean.
<details>
<summary>OS X/Linux</summary>
````{tab} Linux
<br/>
[type this into your terminal]
@ -230,21 +219,29 @@ This walkthrough is going to use a "virtual environment", since that provides a
```
Error: Command '['/home/mroche/Plex-Meta-Manager/pmm-venv/bin/python3', '-Im', 'ensurepip', '--upgrade', '--default-pip']' returned non-zero exit status 1.
```
You probably need to make sure the Python 3.9-specific virtualenv support library is installed.
You probably need to make sure the Python 3.9-specific virtualenv support library is installed:
On Linux [which is the one platform where this was seen at this point]:
[type this into your terminal]
```
sudo apt-get install python3.9-venv
```
</details>
<details>
<summary>Windows</summary>
Then try the original venv command above again.
<br/>
````
````{tab} OS X:
<br/>
[type this into your terminal]
```
python3 -m venv pmm-venv
```
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
```
@ -258,7 +255,8 @@ This walkthrough is going to use a "virtual environment", since that provides a
```
You apparently didn't check the “Add to path” checkbox above under [installing Python](#installing-python). "Repair" your Python install and check "add python to environment variables".
</details>
<br/>
````
<details>
<summary>What did that do?</summary>
@ -281,21 +279,27 @@ That command will not produce any output if it works; it will display an error i
If you aren't looking at an error, you're ready to move on.
---
That will create the virtual environment, and then you need to activate it:
<details>
<summary>OS X/Linux</summary>
````{tab} Linux
<br/>
[type this into your terminal]
```
source pmm-venv/bin/activate
```
</details>
<br/>
````
````{tab} OS X:
<br/>
[type this into your terminal]
<details>
<summary>Windows</summary>
```
source pmm-venv/bin/activate
```
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
@ -317,7 +321,9 @@ You apparently skipped the "enable scripts in Powershell" step above under [inst
You will need to take care of that before moving on. Follow the instructions [here](https://windowsloop.com/enable-powershell-scripts-execution-windows-10).
</details>
Once you have done that, try the activation step again.
<br/>
````
That command will not produce any output if it works; it will display an error if a problem occurs.
@ -338,32 +344,37 @@ Note that the prompt now shows the name of the virtual environment. You may not
</details>
---
An advantage of doing this in a virutal environment is that in the event something goes wrong with this part of the setup, you can delete that pmm-venv directory and do the setup again.
An advantage of doing this in a virtual environment is that in the event something goes wrong with this part of the setup, you can delete that pmm-venv directory and do the setup again.
**IMPORTANT: In the future, when you want to run the script, you will need to do this "activation" step every time. Not the venv creation, just the activation**:
<details>
<summary>OS X/Linux</summary>
````{tab} Linux
<br/>
[type this into your terminal]
```
source pmm-venv/bin/activate
```
</details>
<br/>
````
````{tab} OS X:
<br/>
[type this into your terminal]
<details>
<summary>Windows</summary>
```
source pmm-venv/bin/activate
```
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
```
.\pmm-venv\Scripts\activate
```
</details>
<br/>
````
### Installing requirements
@ -402,10 +413,9 @@ Don't worry about the WARNING about `pip version thus-and-such` if it comes up.
</details>
Let’s make sure it’s working so far. [type this into your terminal]:
Let’s make sure it’s working so far.
```
python plex_meta_manager.py -r
```{include} wt/wt-run-shell.md
```
This is going to fail with an error, which you will then fix.
@ -418,331 +428,130 @@ Config Error: config not found at /Users/mroche/Plex-Meta-Manager/config
That error means you don’t have a config file, but we at least know that the requirements are in place and the script can run.
### Setting up the initial config file
Next you’ll set up the config file. ThIs tells PMM how to connect to Plex and a variety of other services.
Before you do this you’ll need:
1. TMDb API key. They’re free.
1. Plex URL and Token
There are a bunch of other services you *can* configure in the config file, but these two are the bare minimum.
#### Getting a TMDb API Key
Note that if you already have an API key, you can use that one. You don’t need another.
Go to https://www.themoviedb.org/. Log into your account [or create one if you don’t have one already], then go to “Settings” under your account menu.
In the sidebar menu on the left, select “API”.
Click to generate a new API key under "Request an API Key". If there is already one there, copy it and go to the [next step](#getting-a-plex-url-and-token).
### Create a directory to quiet an error later
There will be a form to fill out; the answers are arbitrary. The URL can be your personal website, or probably even google.com or the like.
The default config file contains a reference to a directory that will show an error in the output later. That error can safely be ignored, but it causes some confusion with new users from time to time.
Once you’ve done that there should be an API Key available on this screen.
We'll create it here so the error doesn't show up later.
Copy that value, you’ll need it for the config file.
````{tab} Linux
<br/>
[type this into your terminal]
#### Getting a Plex URL and Token
```
mkdir config/assets
```
<br/>
````
````{tab} OS X:
<br/>
[type this into your terminal]
The Plex URL is whatever URL you’d use **from this machine** to connect directly to your Plex server [i.e. NOT app.plex.tv].
```
mkdir config/assets
```
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
As with the TMDb API Key, if you already have a Plex Token, you can use that one.
```
mkdir config\assets
```
<br/>
````
This article describes how to get a token: [Finding an authentication token](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/)
### Setting up the initial config file
```{include} wt/wt-01.md
```
#### Editing the config template
First, make a copy of the template. This is going to create a copy of the base template that you can then edit. You only need to do this once.
I’m using `nano` here simply because it’s built into OSX. On Linux you may need to install `nano`, or you can use any other text editor you wish, provided it saves files as PLAIN TEXT.
</details>
<details>
<summary>Windows</summary>
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
```
notepad .\config\config.yml
```
I’m using `notepad` here simply because it’s built into Windows. You can use any other text editor you wish, provided it saves files as PLAIN TEXT.
</details>
From here on in, when I say "open the config file", I mean this `nano` or `notepad` command. **Don't copy the template again**.
---
Scroll down a bit and update the three things you just collected; Plex URL, Plex Token, and TMDb API Key.
```yaml
plex: # Can be individually specified per library as well
## This file is a template remove the .template to use the file
Now open the copy in an editor:
libraries: # This is called out once within the config.yml file
Movies: # Each library must match the Plex library name
metadata_path:
- file: config/Movies.yml # This is a local file on the system
- folder: config/Movies/ # This is a local directory on the system
- git: meisnate12/MovieCharts # This is a file within the GitHub Repository
TV Shows:
metadata_path:
- file: config/TVShows.yml
- folder: config/TV Shows/
- git: meisnate12/ShowCharts # This points to the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
Anime:
metadata_path:
- file: config/Anime.yml
Music:
metadata_path:
- file: config/Music.yml
```{include} wt/wt-editor.md
```
You will ultimately need an entry here for each of the libraries on which you want PMM to act. Those top-level elements [Movies, TV Shows, Anime, Music] are names of libraries on your Plex server.
For now, delete the “TV Shows”, “Anime”, and "Music" sections and change the name of the “Movies” section to “Movies-NOSUCHLIBRARY":
```yaml
libraries:
Movies-NOSUCHLIBRARY: ## <<<CHANGETHISLINE
metadata_path:
- file: config/Movies.yml
- git: meisnate12/MovieCharts
```{include} wt/wt-02.md
```
This is intended to cause an error for illustration that you will then fix.
#### Testing the config file
Save the file [in nano that would be cntl-x, y, return], then run the script again:
[type this into your terminal]
Save the file:
```shell
python plex_meta_manager.py -r
```{include} wt/wt-save.md
```
I’ve removed some of the lines for space, but have left the important bits:
Then run the script again:
```{include} wt/wt-run-docker.md
```
...
| Starting Run|
...
| Locating config...
|
| Using /Users/mroche/Plex-Meta-Manager/config/config.yml as config
...
| Connecting to TMDb...
| TMDb Connection Successful
...
| Connecting to Plex Libraries...
...
| Connecting to Movies-NOSUCHLIBRARY Library...
| Plex Error: Plex Library Movies-NOSUCHLIBRARY not found
| Movies-NOSUCHLIBRARY Library Connection Failed
...
```
You can see there that PMM found its config file, was able to connect to TMDb, was able to connect to Plex, and then failed trying to read the “Movies-NOSUCHLIBRARY library, which of course doesn’t exist.
Open the config file again and change "Movies-NOSUCHLIBRARY" to reflect *your own* Plex. Then delete any lines that start with “git”. Those are all sets of collections, and we just want to create a few as examples.
My Movies library is called “Main Movies", so mine looks like this:
```yaml
libraries:
Main Movies: ## <<<CHANGETHISLINE
metadata_path:
- file: config/Movies.yml
```{include} wt/wt-03.md
```
Save the file and run the script again:
[type this into your terminal]
Save the file:
```
python plex_meta_manager.py -r
```{include} wt/wt-save.md
```
Now you’ll see some more activity in the Plex connection section:
Then run the script again:
```shell
$ python plex_meta_manager.py -r
...
| Connecting to Plex Libraries...
...
| Connecting to Main Movies Library...
...
| Loading Metadata File: config/Movies.yml
|
| YAML Error: File Error: File does not exist config/Movies.yml
...
| Metadata File Error: No valid metadata files found
|
| Main Movies Library Connection Failed
...
```{include} wt/wt-run-shell.md
```
PMM may start cataloging your movies at this point; you cna hit control-C to stop that if it's happening.
We can see there that it connected to the Plex Library but failed to find that `Movies.yml` metadata file.
So far so good.
```{include} wt/wt-04.md
```
### Setting up a metadata file and creating a few sample collections.
Now we have to set up that metadata file that PMM just complained about.
This metadata file contains definitions of the actions you want PMM to take; these can be things like creating collections or playlists, adding overlays, changing things like posters, etc. You can find lots of examples [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs) and throughout the wiki.
For now we’re going to create a few collections so you can watch the process work, then you’re on your own to create whatever others you want.
First, open the metadata file [this will create the file if it doesn't already exist]:
<details>
<summary>OS X/Linux</summary>
<br/>
[type this into your terminal]
```{include} wt/wt-05.md
```
nano "config/Movies.yml"
```
</details>
<details>
<summary>Windows</summary>
<br/>
[type this into your terminal]
Save the file:
```{include} wt/wt-save.md
```
notepad "config\Movies.yml"
```
</details>
In this file, add the following, exactly as it is shown here:
```yaml
templates:
Actor:
actor: tmdb
tmdb_person: <<person>>
tmdb_actor_details: <<person>>
sort_title: +_<<collection_name>>
sync_mode: sync
collection_order: release
collection_mode: hide
collections:
Bill Murray:
template: {name: Actor, person: 1532}
Best of the 1980s:
tmdb_discover:
primary_release_date.gte: 01/01/1980
primary_release_date.lte: 12/31/1989
with_original_language: en
sort_by: popularity.desc
limit: 100
summary: A collection of the Top Content of the 1980s
I chose a letterboxd list for the last one since trakt requires authentication and again, I didn’t want to complicate this walkthrough.
This is going to create three collections. One contains movies that feature Bill Murray. One is up to 100 movies that came out in the 1980s sorted by popularity. The last are movies that appear on a list of good endings according to Vulture.
The first one is based on a template to illustrate that concept. If you wanted to create a collection for another actor you just have to copy and edit those two lines [the ID comes from TMDb]. All the other config details come from the template.
Save the file and run the script again.
[type this into your terminal]
Then run the script again:
```{include} wt/wt-run-docker.md
```
python plex_meta_manager.py -r
```
This time you should see that the metadata file gets loaded:
```{include} wt/wt-06.md
```
| Loading Metadata File: config/Movies.yml
| Metadata File Loaded Successfully
```
And this time it will catalog all your movies. This could take a while depending on how many movies are in that library. Don't cancel it this time.
Once this cataloging is complete it will move on to build those three collections.
As it builds the collections, you should see a fair amount of logging showing which movies are being added to each collection and which ones aren’t found. Once it completes, go to Plex, go to your Movies library, and click “Collections” at the top.
When you click into each, you’ll see the movies that PMM added to each collection.
Each time you run the script, new movies that match the collection definition will be added. For example, if you don’t have “The Razors’ Edge” now, when you download it and run PMM again it will be added to the Bill Murray collection.
If you download any of the missing 22 movies on the Vulture list, running PMM would add them to that collection. And so on.
What comes next:
Delete these three collections if you want, from both Plex and the metadata file [`config/Movies.yml`].
Edit `Movies.yml` to reflect the actions you want PMM to perform on *your* libraries.
TV Shows and other libraries work the same way as you've seen above. Create a section under `Libraries:` in the config.yml, create a metadata file, define collections, run the script.
Investigate the rest of the wiki to learn about everything Plex-Meta-Manager can do for you.
When you are done, deactivate the virtual environment:
@ -756,129 +565,92 @@ deactivate
### I want to update to the latest version of PMM
<details>
<summary>OS X/Linux</summary>
````{tab} Linux
<br/>
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
cd ~/Plex-Meta-Manager
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
</details>
<details>
<summary>Windows</summary>
<br/>
[type this into your terminal]
```
cd C:\Users\mroche\Plex-Meta-Manager
git pull
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
</details>
### I want to use the develop branch
<details>
<summary>OS X/Linux</summary>
````
````{tab} OS X:
<br/>
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
git checkout develop
cd ~/Plex-Meta-Manager
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
</details>
<details>
<summary>Windows</summary>
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
```
cd C:\Users\mroche\Plex-Meta-Manager
git checkout develop
cd ~\Plex-Meta-Manager
git pull
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
</details>
<br/>
````
### I want to use the nightly branch
### I want to use the develop branch
<details>
<summary>OS X/Linux</summary>
````{tab} Linux
<br/>
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
git checkout nightly
cd ~/Plex-Meta-Manager
git checkout develop
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
</details>
<details>
<summary>Windows</summary>
<br/>
[type this into your terminal]
```
cd C:\Users\mroche\Plex-Meta-Manager
git checkout nightly
git pull
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
</details>
### I want to use the master branch
<details>
<summary>OS X/Linux</summary>
````
````{tab} OS X:
<br/>
[type this into your terminal]
```
cd /Users/mroche/Plex-Meta-Manager
git checkout master
cd ~/Plex-Meta-Manager
git checkout develop
git pull
source pmm-venv/bin/activate
python -m pip install -r requirements.txt
```
</details>
<details>
<summary>Windows</summary>
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
```
cd C:\Users\mroche\Plex-Meta-Manager
git checkout master
cd ~/Plex-Meta-Manager
git checkout develop
git pull
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
</details>
<br/>
````
### I want to use the nightly branch
Follow the instructions for the `develop` branch above, subsituting `nightly` for `develop`
### I want to use the master branch
Follow the instructions for the `develop` branch above, subsituting `master` for `develop`
The reinstall of requirements every time is probably overkill, but it's harmless and ensures that you always get any new versions or new requirements.
Next you’ll set up the config file. ThIs tells PMM how to connect to Plex and a variety of other services.
Before you do this you’ll need:
1. TMDb API key. They’re free.
1. Plex URL and Token
There are a bunch of other services you *can* configure in the config file, but these two are the bare minimum.
#### Getting a TMDb API Key
Note that if you already have an API key, you can use that one. You don’t need another.
Go to https://www.themoviedb.org/. Log into your account [or create one if you don’t have one already], then go to “Settings” under your account menu.
In the sidebar menu on the left, select “API”.
Click to generate a new API key under "Request an API Key". If there is already one there, copy it and go to the next step.
There will be a form to fill out; the answers are arbitrary. The URL can be your personal website, or probably even google.com or the like.
Once you’ve done that there should be an API Key available on this screen.
Copy that value, you’ll need it for the config file.
#### Getting a Plex URL and Token
The Plex URL is whatever URL you’d use **from this machine** to connect directly to your Plex server [i.e. NOT app.plex.tv].
As with the TMDb API Key, if you already have a Plex Token, you can use that one.
This article will describe how to get a token: [Finding an authentication token](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/)
## This file is a template remove the .template to use the file
libraries: # This is called out once within the config.yml file
Movies: # Each library must match the Plex library name
metadata_path:
- file: config/Movies.yml # This is a local file on the system
- folder: config/Movies/ # This is a local directory on the system
- git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
- git: PMM/chart/imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
overlay_path:
- remove_overlays: false # Set this to true to remove all overlays
- file: config/Overlays.yml # This is a local file on the system
- git: PMM/overlays/imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
TV Shows:
metadata_path:
- file: config/TVShows.yml
- folder: config/TV Shows/
- git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
- git: PMM/chart/imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
overlay_path:
- remove_overlays: false # Set this to true to remove all overlays
- file: config/Overlays.yml # This is a local file on the system
- git: PMM/overlays/imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
Anime:
metadata_path:
- file: config/Anime.yml
- git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
- git: PMM/chart/anilist # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
Music:
metadata_path:
- file: config/Music.yml
```
You will ultimately need an entry here for each of the libraries on which you want PMM to act. Those top-level elements [Movies, TV Shows, Anime, Music] are names of libraries on your Plex server.
For now, delete the “TV Shows”, “Anime”, and "Music" sections and change the name of the “Movies” section to “Movies-NOSUCHLIBRARY":
```yaml
libraries:
Movies-NOSUCHLIBRARY: ## <<<CHANGETHISLINE
metadata_path:
- file: config/Movies.yml # This is a local file on the system
- folder: config/Movies/ # This is a local directory on the system
- git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
- git: PMM/chart/imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
overlay_path:
- remove_overlays: false # Set this to true to remove all overlays
- file: config/Overlays.yml # This is a local file on the system
- git: PMM/overlays/imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
```
This is intended to cause an error for illustration that you will then fix.
| Plex Error: No Plex libraries were connected to |
...
```
You can see there that PMM found its config file, was able to connect to TMDb, was able to connect to Plex, and then failed trying to read the “Movies-NOSUCHLIBRARY" library, which of course doesn’t exist.
Open the config file again and change "Movies-NOSUCHLIBRARY" to reflect *your own* Movie library in Plex. Then delete all but the first line under the "metadata_path” heading. A few of them will create sets of collections, and we just want to create a few as examples.
My Movies library is called “Main Movies", so mine looks like this:
Now we have to set up that metadata file that PMM just complained about.
This metadata file contains definitions of the actions you want PMM to take; these can be things like creating collections or playlists, adding overlays, changing things like posters, etc. You can find lots of examples [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs) and throughout the wiki.
For now we’re going to create a few collections so you can watch the process work, then you’re on your own to create whatever others you want.
First, open the metadata file [this will create the file if it doesn't already exist]:
````{tab} Linux
<br/>
[type this into your terminal]
```
nano "config/Movies.yml"
```
<br/>
````
````{tab} OS X:
<br/>
[type this into your terminal]
```
nano "config/Movies.yml"
```
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
```
notepad "config\Movies.yml"
```
<br/>
````
In this file, add the following, exactly as it is shown here:
```yaml
templates:
Actor:
actor: tmdb
tmdb_person: <<person>>
tmdb_actor_details: <<person>>
sort_title: +_<<collection_name>>
sync_mode: sync
collection_order: release
collection_mode: hide
collections:
Bill Murray:
template: {name: Actor, person: 1532}
Best of the 1980s:
tmdb_discover:
primary_release_date.gte: 01/01/1980
primary_release_date.lte: 12/31/1989
with_original_language: en
sort_by: popularity.desc
limit: 100
summary: A collection of the Top Content of the 1980s
I chose a letterboxd list for the last one since trakt requires authentication and again, I didn’t want to complicate this walkthrough.
This is going to create three collections. One contains movies that feature Bill Murray. One is up to 100 movies that came out in the 1980s sorted by popularity. The last are movies that appear on a list of good endings according to Vulture.
The first one is based on a template to illustrate that concept. If you wanted to create a collection for another actor you just have to copy and edit those two lines [the ID comes from TMDb]. All the other config details come from the template.
This time you should see that the metadata file gets loaded:
```
| Loading Metadata File: config/Movies.yml
| Metadata File Loaded Successfully
```
And this time it will catalog all your movies. This could take a while depending on how many movies are in that library.
Once this mapping is complete it will move on to build those three collections.
As it builds the collections, you should see a fair amount of logging about which movies are being added and which ones aren’t found. Once it completes, go to Plex, go to your Movies library, and click “Collections” at the top.
You should see the three new collections:
When you click into each, you’ll see the movies that PMM added to each collection.
Each time you run the script, new movies that match the collection definition will be added. For example, if you don’t have “The Razors’ Edge” now, when you download it and run PMM again it will be added to the Bill Murray collection.
If you download any of the missing 22 movies on the Vulture list, running PMM would add them to that collection. And so on.
### What comes next:
Delete these three collections if you want, from both Plex and the metadata file [`config/Movies.yml`].
Edit `Movies.yml` to reflect the actions you want PMM to perform on *your* libraries.
TV Shows and other libraries work the same way as you've seen above. Create a section under `Libraries:` in the config.yml, create a metadata file, define collections, run the script.
Investigate the rest of the wiki to learn about everything Plex-Meta-Manager can do for you.
I’m using `nano` here mostly because it’s simpler than any other editor on Linux.
If you see something like:
```bash
$ nano config/config.yml
zsh: command not found: nano
```
You need to install `nano`, which you would do with:
[type this into your terminal]
```
sudo apt install nano
```
You can use any other text editor you wish, provided it saves files as PLAIN TEXT. `vi`, `emacs`, etc.
<br/>
````
````{tab} OS X:
<br/>
[type this into your terminal]
```
nano config/config.yml
```
I’m using `nano` here simply because it’s built into OSX. You can use any other text editor you wish, provided it saves files as PLAIN TEXT. BBedit, TextMate, VSCode, etc.
A common mistake is using TextEdit.app, which saves files as RTF by default.
<br/>
````
````{tab} Windows:
<br/>
[type this into your terminal]
```
notepad .\config\config.yml
```
I’m using `notepad` here simply because it’s built into Windows. You can use any other text editor you wish, provided it saves files as PLAIN TEXT.
<br/>
````
From here on in, when this walkthrough says "open the config file", I mean this `nano` or `notepad` command. **Don't copy the template again**.
Chaz Larson
2 years ago
committed by
meisnate12