@ -16,6 +16,8 @@ Plex Meta Manager is an open source Python 3 project that has been designed to e
## Getting Started
## Getting Started
These are the high-level steps you must take to get Plex Meta Manager up and running:
1. Install Plex Meta Manager; this process is described [here](https://metamanager.wiki/en/latest/home/installation.html).
1. Install Plex Meta Manager; this process is described [here](https://metamanager.wiki/en/latest/home/installation.html).
2. Once installed, you have to create a [Configuration File](https://metamanager.wiki/en/latest/config/configuration.html), which contains URLs and credentials and the like which are used to connect to services like Plex and TMDb.
2. Once installed, you have to create a [Configuration File](https://metamanager.wiki/en/latest/config/configuration.html), which contains URLs and credentials and the like which are used to connect to services like Plex and TMDb.
@ -34,6 +36,10 @@ If you find steps 1-3 above daunting, there are some walkthroughs available that
## Development & Nightly Builds
## Development & Nightly Builds
Development and Nightly builds are deemed as "beta" builds which are updated far more frequently than the master branch. Bug fixes, new features and and any other code added to Plex Meta Manager first goes to the nightly branch, followed by the develop branch, before finally being released to the master branch.
The development builds (particularly the nightly branch) is only recommended for those who have a technical knowledge of Plex Meta Manager, and are happy with having to frequently update to receive the latest changes.
### Development
### Development
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
@ -12,7 +12,6 @@ This example is an advanced version of the library mappings which highlights som
<details>
<details>
<summary>Click to Expand</summary>
<summary>Click to Expand</summary>
<br/>
In this example, the `"TV Shows On Second Plex"` library has a library-level `plex` configuration, which takes priority over the `plex` configuration set at the global level. <br>
In this example, the `"TV Shows On Second Plex"` library has a library-level `plex` configuration, which takes priority over the `plex` configuration set at the global level. <br>
@ -97,8 +96,7 @@ The available attributes for each library are as follows:
Each library that the user wants Plex Meta Manager to interact with must be documented with a library attribute. A library attribute is represented by the mapping name (i.e. `Movies` or `TV Shows`), this must have a unique name that correlates with a library of the same name within the Plex Media Server. In the situation that two servers are being connected to which both have libraries of the same name, the `library_name` attribute can be utilized to specify the real Library Name, whilst the library attribute's mapping name can be made into a placeholder. This is showcased below:
Each library that the user wants Plex Meta Manager to interact with must be documented with a library attribute. A library attribute is represented by the mapping name (i.e. `Movies` or `TV Shows`), this must have a unique name that correlates with a library of the same name within the Plex Media Server. In the situation that two servers are being connected to which both have libraries of the same name, the `library_name` attribute can be utilized to specify the real Library Name, whilst the library attribute's mapping name can be made into a placeholder. This is showcased below:
<details>
<details>
<summary>Click to Expand</summary>
<summary>Example</summary>
<br/>
```yaml
```yaml
libraries:
libraries:
@ -152,7 +150,10 @@ libraries:
- file: config/Overlays.yml
- file: config/Overlays.yml
```
```
#### Remove Overlays
#### Special Overlay Path Calls
<details>
<summary>Remove Overlays</summary>
You can remove overlays from a library by adding `remove_overlays: true` to `overlay_path`. This will remove all overlays when run and not generate new ones.
You can remove overlays from a library by adding `remove_overlays: true` to `overlay_path`. This will remove all overlays when run and not generate new ones.
@ -165,8 +166,10 @@ libraries:
- remove_overlays: true
- remove_overlays: true
- file: config/Overlays.yml
- file: config/Overlays.yml
```
```
</details>
#### Reapply Overlays
<details>
<summary>Reapply Overlays</summary>
You can reapply overlays from a library by adding `reapply_overlays: true` to `overlay_path`. This will reapply overlays to every item in your library.
You can reapply overlays from a library by adding `reapply_overlays: true` to `overlay_path`. This will reapply overlays to every item in your library.
@ -179,8 +182,10 @@ libraries:
- reapply_overlays: true
- reapply_overlays: true
- file: config/Overlays.yml
- file: config/Overlays.yml
```
```
</details>
#### Reset Overlays
<details>
<summary>Reset Overlays</summary>
You can reset overlays from a library by adding `reset_overlays` to `overlay_path` and setting it to either `tmdb` or `plex` depending on where you want to source the images from. This will use the reset image when overlaying items in your library.
You can reset overlays from a library by adding `reset_overlays` to `overlay_path` and setting it to either `tmdb` or `plex` depending on where you want to source the images from. This will use the reset image when overlaying items in your library.
@ -193,8 +198,10 @@ libraries:
- reset_overlays: plex
- reset_overlays: plex
- file: config/Overlays.yml
- file: config/Overlays.yml
```
```
</details>
#### Schedule Overlays
<details>
<summary>Schedule Overlays</summary>
You can schedule all overlays from a library by adding `schedule` to `overlay_path` and setting it to [Any Schedule Option](../metadata/details/schedule).
You can schedule all overlays from a library by adding `schedule` to `overlay_path` and setting it to [Any Schedule Option](../metadata/details/schedule).
The [`metadata_path`](libraries.md#metadata-path) attribute is defined under the [`libraries`](libraries) attribute in your [Configuration File](configuration).
The [`metadata_path`](libraries.md#metadata-path) attribute is defined under the [`libraries`](libraries) attribute in your [Configuration File](configuration).
### Example
<details>
<details>
<summary>Click to Expand</summary>
<summary>Example</summary>
<br/>
In this example, multiple metadata file path types are defined for the `"TV Shows"` library:
In this example, multiple metadata file path types are defined for the `"TV Shows"` library:
@ -122,11 +119,8 @@ Within the above example, PMM will:
The [`overlay_path`](libraries.md#overlay-path) attribute is defined under the [`libraries`](libraries) attribute in your [Configuration File](configuration).
The [`overlay_path`](libraries.md#overlay-path) attribute is defined under the [`libraries`](libraries) attribute in your [Configuration File](configuration).
### Example
<details>
<details>
<summary>Click to Expand</summary>
<summary>Example</summary>
<br/>
In this example, multiple overlay file path types are defined for the `"TV Shows"` library:
In this example, multiple overlay file path types are defined for the `"TV Shows"` library:
@ -155,11 +149,8 @@ Within the above example, PMM will:
The [`playlist_files`](playlists) at the top level in your [Configuration File](configuration).
The [`playlist_files`](playlists) at the top level in your [Configuration File](configuration).
### Example
<details>
<details>
<summary>Click to Expand</summary>
<summary>Example</summary>
<br/>
In this example, multiple `playlist_files` attribute path types are defined:
In this example, multiple `playlist_files` attribute path types are defined:
@ -186,11 +177,8 @@ Within the above example, PMM will:
The [`external_templates`](../metadata/templates.md#external-templates) attribute is defined at the top level in your [Metadata File](../metadata/metadata).
The [`external_templates`](../metadata/templates.md#external-templates) attribute is defined at the top level in your [Metadata File](../metadata/metadata).
### Example
<details>
<details>
<summary>Click to Expand</summary>
<summary>Example</summary>
<br/>
In this example, multiple external template file path types are defined:
In this example, multiple external template file path types are defined:
That’s a command you’re going to type or paste into your terminal (OSX or Linux) or Powershell (Windows).
That’s a command you’re going to type or paste into your terminal (OSX or Linux) or Powershell (Windows).
IMPORTANT NOTE:
**IMPORTANT NOTES:**
This walkthrough is going to be pretty pedantic. I’m assuming you’re reading it because you have no idea how to get a Docker container going, so I’m proceeding from the assumption that you want to be walked through every little detail. You’re going to deliberately cause errors and then fix them as you go through it. This is to help you understand what exactly is going on behind the scenes so that when you see these sorts of problems in the wild you will have some background to understand what’s happening. If I only give you the happy path walkthrough, then when you make a typo later on you’ll have no idea where that typo might be or why it’s breaking things.
I am assuming you do not have any of these tools already installed. When writing this up I started with a brand new Windows 10 install.
1. This walkthrough is going to be pretty pedantic. I’m assuming you’re reading it because you have no idea how to get a Docker container going, so I’m proceeding from the assumption that you want to be walked through every little detail. You’re going to deliberately cause errors and then fix them as you go through it. This is to help you understand what exactly is going on behind the scenes so that when you see these sorts of problems in the wild you will have some background to understand what’s happening. If I only give you the happy path walkthrough, then when you make a typo later on you’ll have no idea where that typo might be or why it’s breaking things.
I'm also assuming you are doing this on a computer, not through a NAS interface or the like. You can do all this through something like the Synology NAS UI or Portainer or the like, but those aren't documented here. This uses the docker command line because it works the same on all platforms.
2. I am assuming you do not have any of these tools already installed. When writing this up I started with a brand new Windows 10 install.
You may want to take an hour to get familiar with Docker fundamentals with the [official tutorial](https://www.docker.com/101-tutorial/).
3. I'm also assuming you are doing this on a computer, not through a NAS interface or the like. You can do all this through something like the Synology NAS UI or Portainer or the like, but those aren't documented here. This uses the docker command line because it works the same on all platforms.
DO NOT MAKE ANY CHANGES BELOW if you want this to just work. Don't change the docker image [`linuxserver.io` will not work for this, for example]; don't change the paths, etc.
4. You may want to take an hour to get familiar with Docker fundamentals with the [official tutorial](https://www.docker.com/101-tutorial/).
5. DO NOT MAKE ANY CHANGES BELOW if you want this to just work. Don't change the docker image [`linuxserver.io` will not work for this, for example]; don't change the paths, etc.
### Installing Docker.
### Installing Docker.
@ -56,17 +57,13 @@ The Docker install is discussed here: [Installing Docker](https://docs.docker.co
Once you have Docker installed, test it at the command line with:
Once you have Docker installed, test it at the command line with:
[type this into your terminal]
[type this into your terminal]
```
```
docker run --rm hello-world
docker run --rm hello-world
```
```
You should see something that starts with:
You should see something that starts with:
```
```
Hello from Docker!
Hello from Docker!
This message shows that your installation appears to be working correctly.
This message shows that your installation appears to be working correctly.
...
...
```
```
@ -143,82 +140,55 @@ pwd
This will display a full path:
This will display a full path:
````{tab} Linux
````{tab} Linux
<br/>
```
```
/home/YOURUSERNAME/plex-meta-manager
/home/YOURUSERNAME/plex-meta-manager
```
```
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
```
```
/Users/YOURUSERNAME/plex-meta-manager
/Users/YOURUSERNAME/plex-meta-manager
```
```
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
```
```
C:\Users\YOURUSERNAME\plex-meta-manager
C:\Users\YOURUSERNAME\plex-meta-manager
```
```
<br/>
````
````
Add "config" onto the end of that to get the host path to your config directory, for example:
Add "config" onto the end of that to get the host path to your config directory, for example:
````{tab} Linux
````{tab} Linux
<br/>
```
```
/home/YOURUSERNAME/plex-meta-manager/config
/home/YOURUSERNAME/plex-meta-manager/config
```
```
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
```
```
/Users/YOURUSERNAME/plex-meta-manager/config
/Users/YOURUSERNAME/plex-meta-manager/config
```
```
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
```
```
C:\Users\YOURUSERNAME\plex-meta-manager\config
C:\Users\YOURUSERNAME\plex-meta-manager\config
```
```
<br/>
````
````
You'll need to add this to the docker command every time you run it, like this:
You'll need to add this to the docker command every time you run it, like this:
````{tab} Linux
````{tab} Linux
<br/>
```
```
docker run --rm -it -v "/home/YOURUSERNAME/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager
docker run --rm -it -v "/home/YOURUSERNAME/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager
```
```
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
```
```
docker run --rm -it -v "/Users/YOURUSERNAME/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager
docker run --rm -it -v "/Users/YOURUSERNAME/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager
```
```
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
```
```
docker run --rm -it -v "C:\Users\YOURUSERNAME\plex-meta-manager\config:/config:rw" meisnate12/plex-meta-manager
docker run --rm -it -v "C:\Users\YOURUSERNAME\plex-meta-manager\config:/config:rw" meisnate12/plex-meta-manager
```
```
<br/>
````
````
If you run that command now it will display a similar error to before, but without all the image loading:
If you run that command now it will display a similar error to before, but without all the image loading:
@ -232,7 +202,6 @@ Note that I show the example path there.
<details>
<details>
<summary>Why did we create that `config' directory?</summary>
<summary>Why did we create that `config' directory?</summary>
<br/>
This was done so that from here on in the instructions match between this walkthrough and the [Local walkthrough](local) are the same.
This was done so that from here on in the instructions match between this walkthrough and the [Local walkthrough](local) are the same.
@ -246,31 +215,22 @@ The default config file contains a reference to a directory that will show an er
We'll create it here so the error doesn't show up later.
We'll create it here so the error doesn't show up later.
````{tab} Linux
````{tab} Linux
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
mkdir config/assets
mkdir config/assets
```
```
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
mkdir config/assets
mkdir config/assets
```
```
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
mkdir config\assets
mkdir config\assets
```
```
<br/>
````
````
### Setting up the initial config file
### Setting up the initial config file
@ -283,30 +243,22 @@ mkdir config\assets
First, make a copy of the template:
First, make a copy of the template:
````{tab} Linux
````{tab} Linux
<br/>
Get a copy of the template to edit [type this into your terminal]:
Get a copy of the template to edit [type this into your terminal]:
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:
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:
@ -51,21 +51,17 @@ Since most of this is typing commands into a terminal, you'll need to have a ter
````{tab} Linux
````{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 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 throughout this walkthrough, 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 throughout this walkthrough, so leave it open.
<br/>
````
````
````{tab} OS X:
````{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.
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.
You can also use iTerm or some other terminal app if you wish. If you don't know what that means, use Terminal.
You can also use iTerm or some other terminal app if you wish. If you don't know what that means, use Terminal.
<br/>
````
````
````{tab} Windows:
````{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.
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.
### Installing Python.
@ -82,21 +78,17 @@ python --version
If one of these doesn't return `3.7.0` or higher, you'll need to get Python 3 installed.
If one of these doesn't return `3.7.0` or higher, you'll need to get Python 3 installed.
````{tab} Linux
````{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.
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.
<br/>
````
````
````{tab} OS X:
````{tab} OS X
Follow the instructions here: [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/)
Follow the instructions here: [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/)
<br/>
````
````
````{tab} Windows:
````{tab} Windows
Go to http://www.python.org/download and download one less than 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. The latest version of Python is 3.11, and there is one piece of PMM that is not ready for 3.11. It will be some time soon, but that isn't under PMM control, so to be safe, grab one back from the latest.
Go to http://www.python.org/download and download one less than 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. The latest version of Python is 3.11, and there is one piece of PMM that is not ready for 3.11. It will be some time soon, but that isn't under PMM control, so to be safe, grab one back from the latest.
Once downloaded, run the installer. Tick “Add to path” checkbox at the bottom and click “Install Now”.
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.
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.
<br/>
````
````
Once you've completed the install, verify that will will work on the command line. Close the terminal or Powershell window and open a new one, then type this into your terminal:
Once you've completed the install, verify that will will work on the command line. Close the terminal or Powershell window and open a new one, then type this into your terminal:
@ -123,17 +115,12 @@ git --version
If this doesn't return a version number, you'll need to get git installed.
If this doesn't return a version number, you'll need to get git installed.
````{tab} Linux
````{tab} Linux
<br/>
The git install is discussed here: [Download for Linux and Unix](https://git-scm.com/download/linux)
The git install is discussed here: [Download for Linux and Unix](https://git-scm.com/download/linux)
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
The git install is discussed here: [Git - Downloading Package](https://git-scm.com/download/mac)
The git install is discussed here: [Git - Downloading Package](https://git-scm.com/download/mac)
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
Download the installer from [here](https://git-scm.com/download/windows)
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:
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,7 +128,6 @@ Run the install; you can probably just accept the defaults and click through exc
This install comes with its own command line interface. **Do not use this interface in this walkthrough**. Continue to do everything here in Powershell.
This install comes with its own command line interface. **Do not use this interface in this walkthrough**. Continue to do everything here in Powershell.
<br/>
````
````
Once you've completed the install, verify that will will work on the command line. Close the terminal or Powershell window and open a new one, then type this into your terminal:
Once you've completed the install, verify that will will work on the command line. Close the terminal or Powershell window and open a new one, then type this into your terminal:
@ -181,53 +167,38 @@ There are parts of the code that are assuming and expecting that you will be in
<details>
<details>
<summary>What did that do?</summary>
<summary>What did that do?</summary>
<br/>
```
```
cd ~
cd ~
```
```
This changes to your home directory, which will be something like `/home/yourname` or `/Users/yourname` or `C:\Users\YourName` depending on the platform.
This changes to your home directory, which will be something like `/home/yourname` or `/Users/yourname` or `C:\Users\YourName` depending on the platform.
This uses `git` to make a copy of (`clone`) the PMM code from where it is stored on `github`.
This uses `git` to make a copy of (`clone`) the PMM code from where it is stored on `github`.
```
```
cd Plex-Meta-Manager
cd Plex-Meta-Manager
```
```
This moves into the directory that was created by the `clone` command.
This moves into the directory that was created by the `clone` command.
</details>
</details>
Later on you can move it elsewhere if you want, but for now put it there. This will ensure that everything to follow works just like it says here. Presumably you’re reading this because the other docs are unclear to you. Don’t make unilateral changes to my assumptions while doing this.
Later on you can move it elsewhere if you want, but for now put it there. This will ensure that everything to follow works just like it says here. Presumably you’re reading this because the other docs are unclear to you. Don’t make unilateral changes to my assumptions while doing this.
<details>
<details>
<summary>Why use git instead of downloading the release ZIP?</summary>
<summary>Why use git instead of downloading the release ZIP?</summary>
<br/>
Retrieving the code with `git` makes updating simpler. When you want to update to the newest version, you can go into this directory and type:
Retrieving the code with `git` makes updating simpler. When you want to update to the newest version, you can go into this directory and type:
```
```
git pull
git pull
```
```
No need to download a new ZIP, uncompress it, etc.
No need to download a new ZIP, uncompress it, etc.
Also, if you are asked to [or want to] switch to the latest develop or nightly code, you can do so with:
Also, if you are asked to [or want to] switch to the latest develop or nightly code, you can do so with:
```
```
git checkout develop
git checkout develop
```
```
```
```
git checkout nightly
git checkout nightly
```
```
</details>
</details>
---
---
@ -237,67 +208,46 @@ 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.
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.
````{tab} Linux
````{tab} Linux
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
python3 -m venv pmm-venv
python3 -m venv pmm-venv
```
```
If you see an error like:
If you see an error like:
```
```
Error: Command '['/home/mroche/Plex-Meta-Manager/pmm-venv/bin/python3', '-Im', 'ensurepip', '--upgrade', '--default-pip']' returned non-zero exit status 1.
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:
[type this into your terminal]
[type this into your terminal]
```
```
sudo apt-get install python3.9-venv
sudo apt-get install python3.9-venv
```
```
Then try the original venv command above again.
Then try the original venv command above again.
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
python3 -m venv pmm-venv
python3 -m venv pmm-venv
```
```
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
python -m venv pmm-venv
python -m venv pmm-venv
```
```
If you see:
If you see:
```
```
Python was not found; run without arguments to install from the Microsoft Store, or disable this shortcut from Settings > Manage App Execution Aliases.
Python was not found; run without arguments to install from the Microsoft Store, or disable this shortcut from Settings > Manage App Execution Aliases.
```
```
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".
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".
<br/>
````
````
<details>
<details>
<summary>What did that do?</summary>
<summary>What did that do?</summary>
<br/>
```
```
python3 -m venv pmm-venv
python3 -m venv pmm-venv
```
```
This tells Python3 to use the `venv` module to create a virtual environment called `pmm-venv`. The only visible effect will be the creation of a `pmm-venv` directory.
This tells Python3 to use the `venv` module to create a virtual environment called `pmm-venv`. The only visible effect will be the creation of a `pmm-venv` directory.
</details>
</details>
That command will not produce any output if it works; it will display an error if a problem occurs. If everything is fine, you will be looking at something like this:
That command will not produce any output if it works; it will display an error if a problem occurs. If everything is fine, you will be looking at something like this:
@ -312,32 +262,23 @@ 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:
That will create the virtual environment, and then you need to activate it:
````{tab} Linux
````{tab} Linux
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
source pmm-venv/bin/activate
source pmm-venv/bin/activate
```
```
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
source pmm-venv/bin/activate
source pmm-venv/bin/activate
```
```
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
.\pmm-venv\Scripts\activate
.\pmm-venv\Scripts\activate
```
```
If you see something like this:
If you see something like this:
```powershell
```powershell
.\pmm-venv\Scripts\activate : File C:\Users\mroche\Plex-Meta-Manager\pmm-venv\Scripts\Activate.ps1 cannot be loaded because running scripts is disabled on this system. For more information, see about_Execution_Policies at https:/go.microsoft.com/fwlink LinkID=135170.
.\pmm-venv\Scripts\activate : File C:\Users\mroche\Plex-Meta-Manager\pmm-venv\Scripts\Activate.ps1 cannot be loaded because running scripts is disabled on this system. For more information, see about_Execution_Policies at https:/go.microsoft.com/fwlink LinkID=135170.
You apparently skipped the "enable scripts in Powershell" step above under [installing Python](#installing-python) for Windows.
You apparently skipped the "enable scripts in Powershell" step above under [installing Python](#installing-python) for Windows.
You will need to take care of that before moving on. Follow the instructions [here](https://windowsloop.com/enable-powershell-scripts-execution-windows-10).
You will need to take care of that before moving on. Follow the instructions [here](https://windowsloop.com/enable-powershell-scripts-execution-windows-10).
Once you have done that, try the activation step again.
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.
That command will not produce any output if it works; it will display an error if a problem occurs.
@ -368,10 +307,8 @@ Note that the prompt now shows the name of the virtual environment. You may not
<details>
<details>
<summary>What did that do?</summary>
<summary>What did that do?</summary>
<br/>
This tells Python to make the virtual environment "active", which means to use the copy of python that is available there, install all support libraries there, etc. This keeps the PMM code and its runtime environment totally separate from your host machine's environment.
This tells Python to make the virtual environment "active", which means to use the copy of python that is available there, install all support libraries there, etc. This keeps the PMM code and its runtime environment totally separate from your host machine's environment.
</details>
</details>
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.
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.
@ -379,31 +316,22 @@ An advantage of doing this in a virtual environment is that in the event somethi
**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**:
**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**:
````{tab} Linux
````{tab} Linux
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
source pmm-venv/bin/activate
source pmm-venv/bin/activate
```
```
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
source pmm-venv/bin/activate
source pmm-venv/bin/activate
```
```
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
.\pmm-venv\Scripts\activate
.\pmm-venv\Scripts\activate
```
```
<br/>
````
````
### Installing requirements
### Installing requirements
@ -437,10 +365,8 @@ Don't worry about the WARNING about `pip version thus-and-such` if it comes up.
<details>
<details>
<summary>What did that do?</summary>
<summary>What did that do?</summary>
<br/>
This told Python to use the `pip` module to install some libraries that PMM needs.
This told Python to use the `pip` module to install some libraries that PMM needs.
</details>
</details>
Let’s make sure it’s working so far.
Let’s make sure it’s working so far.
@ -465,31 +391,22 @@ The default config file contains a reference to a directory that will show an er
We'll create it here so the error doesn't show up later.
We'll create it here so the error doesn't show up later.
````{tab} Linux
````{tab} Linux
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
mkdir config/assets
mkdir config/assets
```
```
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
mkdir config/assets
mkdir config/assets
```
```
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
mkdir config\assets
mkdir config\assets
```
```
<br/>
````
````
### Setting up the initial config file
### Setting up the initial config file
@ -502,31 +419,22 @@ mkdir config\assets
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.
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.
@ -8,12 +8,8 @@ Instead, it is recommended to set an automated scheduling service so that Plex M
**To control how individual parts of PMM are scheduled see the [Schedule detail](../../metadata/details/schedule)**
**To control how individual parts of PMM are scheduled see the [Schedule detail](../../metadata/details/schedule)**
## Docker Run
<details>
<summary>Click to Expand</summary>
<br/>
````{tab} Docker
Using docker is the simplest and most robust solution to automating Plex Meta Manager scheduling.
Using docker is the simplest and most robust solution to automating Plex Meta Manager scheduling.
When running Plex Meta Manager within docker, the session will resume after a system reboot (assuming Docker is set to start at system startup, which is the default) and Plex Meta Manager will run in the background at all times.
When running Plex Meta Manager within docker, the session will resume after a system reboot (assuming Docker is set to start at system startup, which is the default) and Plex Meta Manager will run in the background at all times.
@ -30,16 +26,8 @@ docker run -d \
This will run Plex Meta Manager in the background persistently until it is stopped by the user. While the docker container will be persistently running, Plex Meta Manager will not begin the run until the scheduled time.
This will run Plex Meta Manager in the background persistently until it is stopped by the user. While the docker container will be persistently running, Plex Meta Manager will not begin the run until the scheduled time.
Further customizations of the docker run command can be used to specify set times to run Plex Meta Manager, further information on this and other Run Commands can be found [here](../environmental.md#time-to-run)
Further customizations of the docker run command can be used to specify set times to run Plex Meta Manager, further information on this and other Run Commands can be found [here](../environmental.md#time-to-run)
</details>
````
````{tab} Windows Task Scheduler
## Windows
<details>
<summary>Click to Expand</summary>
<br/>
### Task Scheduler
Windows Task Scheduler is advised for those who followed the Windows instructions in the [Local Walkthrough Guides](local) and/or do not want to run Plex Meta Manager within docker.
Windows Task Scheduler is advised for those who followed the Windows instructions in the [Local Walkthrough Guides](local) and/or do not want to run Plex Meta Manager within docker.
Windows Task Scheduler allows the user to run commands and services at scheduled times and intervals.
Windows Task Scheduler allows the user to run commands and services at scheduled times and intervals.
@ -60,7 +48,6 @@ This is the recommended approach as it allows the user additional control over h
<details>
<details>
<summary>Background Run Scheduled Task</summary>
<summary>Background Run Scheduled Task</summary>
<br/>
1. Create a `waiter.cmd` file by opening the text editor (i.e. Notepad, TextEdit) and pasting the following code:
1. Create a `waiter.cmd` file by opening the text editor (i.e. Notepad, TextEdit) and pasting the following code:
@ -114,7 +101,6 @@ This method will start Plex Meta Manager at the desired time, immediately begin
<details>
<details>
<summary>Single Run Scheduled Task</summary>
<summary>Single Run Scheduled Task</summary>
<br/>
1. Create a `runner.cmd` file by opening the text editor (i.e. Notepad, TextEdit) and pasting the following code:
1. Create a `runner.cmd` file by opening the text editor (i.e. Notepad, TextEdit) and pasting the following code:
@ -171,20 +157,9 @@ This method will start Plex Meta Manager at the desired time, immediately begin
Plex Meta Manager will now run at the set date/time you selected in Step 6, and will run each subsequent day at the same time.
Plex Meta Manager will now run at the set date/time you selected in Step 6, and will run each subsequent day at the same time.
</details><br/>
</details>
</details>
````
## MacOS
````{tab} MacOS Launchd Service
<details>
<summary>Click to Expand</summary>
<br/>
<br/>
<details>
<summary>Launchd Service</summary>
<br/>
1. Create launchd service:
1. Create launchd service:
A couple examples; you'll want to edit the THINGS IN ALL CAPS to reflect your system.
A couple examples; you'll want to edit the THINGS IN ALL CAPS to reflect your system.
@ -278,59 +253,8 @@ Plex Meta Manager will now run at the set date/time you selected in Step 6, and
Note that this command uses the *label*, not the plist filename. The -k options means that the service will first be killed, if running.
Note that this command uses the *label*, not the plist filename. The -k options means that the service will first be killed, if running.
The agent should now be active and starting the program according to the schedule you set.
The agent should now be active and starting the program according to the schedule you set.
</details><br/>
````
````{tab} Linux Systemctl Service
<details>
<summary>cron Schedule</summary>
<br/>
See the cron section below.
</details><br/>
</details>
## Linux
<details>
<summary>Click to Expand</summary>
<br/>
<br/>
<details>
<summary>cron Schedule</summary>
<br/>
1. Decide when you want to run Plex Meta Manager
`cron` needs a specific syntax to express schedules. A cron schedule is something like "Every Tuesday at 4" or "5 minutes past every other hour".
You can generate the required line by checking boxes using something like [crontab-generator](https://crontab-generator.org/).
The command you use in crontab will probably be the command you use to run it on the command line.
A command you could use for this:
```
cd /path/to/plex-meta-manager && pmm-venv/bin/python plex_meta_manager.py --config config/config.yml --run
```
NOTE: This is assuming you created the `pmm-venv` virtual environment as described in the [Local Walkthrough](local)
2. Open the system crontab for editing:
```bash
sudo crontab -e
```
3. Paste in the crontab line you got from `crontab-generator`, or type in one of your own.
4. Save and close the file.
</details><br/>
<details>
<summary>Systemctl Service</summary>
<br/>
1. Create the service file:
1. Create the service file:
@ -381,5 +305,33 @@ See the cron section below.
```shell
```shell
sudo systemctl status plex-meta-manager.service
sudo systemctl status plex-meta-manager.service
```
```
</details><br/>
````
</details>
````{tab} cron
The cron utility is used for running scripts and commands at regular intervals, and at specific times and dates. It’s built into most Operating Systems (namely Linux and Mac), and provides a very useful way to schedule tasks on your server. It also works for running Docker commands on a schedule.
1. Decide when you want to run Plex Meta Manager
`cron` needs a specific syntax to express schedules. A cron schedule is something like "Every Tuesday at 4" or "5 minutes past every other hour".
You can generate the required line by checking boxes using something like [crontab-generator](https://crontab-generator.org/).
The command you use in crontab will probably be the command you use to run it on the command line.
A command you could use for this:
```
cd /path/to/plex-meta-manager && pmm-venv/bin/python plex_meta_manager.py --config config/config.yml --run
```
NOTE: This is assuming you created the `pmm-venv` virtual environment as described in the [Local Walkthrough](local)
2. Open the system crontab for editing:
```bash
sudo crontab -e
```
3. Paste in the crontab line you got from `crontab-generator`, or type in one of your own.
* Full list of docker values can be found on the [Run Commands & Environmental Variables Page](../../home/environmental).
* Full list of docker values can be found on the [Run Commands & Environmental Variables Page](../../home/environmental).
* If you wish to enable one-time [Run]([Run Commands & Environmental Variables Page](../environmental.md#run)), add `-r` to `Post Arguments` by enabling Advanced View in the top right of unRAID.
* If you wish to enable one-time [Run]([Run Commands & Environmental Variables Page](../environmental.md#run)), add `-r` to `Post Arguments` by enabling Advanced View in the top right of unRAID.
You can use any other text editor you wish, provided it saves files as PLAIN TEXT. `vi`, `emacs`, etc.
You can use any other text editor you wish, provided it saves files as PLAIN TEXT. `vi`, `emacs`, etc.
<br/>
````
````
````{tab} OS X:
````{tab} OS X
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
@ -36,18 +33,14 @@ 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.
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.
A common mistake is using TextEdit.app, which saves files as RTF by default.
<br/>
````
````
````{tab} Windows:
````{tab} Windows
<br/>
[type this into your terminal]
[type this into your terminal]
```
```
notepad .\config\config.yml
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.
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**.
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**.
There are many occurrences of these special characters where quotes are not needed but if the YAML fails to load it could easily be because one of these are unquoted.
There are many occurrences of these special characters where quotes are not needed but if the YAML fails to load it could easily be because one of these are unquoted.
| `[INFO]` | `Detail: TMDb_person updated poster to [URL]` | Person image was downloaded from TMDb | May require you to update the people poster image to your style or request it in the style of the PMM defaults people posters |
| `[INFO]` | `Detail: TMDb_person updated poster to [URL]` | Person image was downloaded from TMDb | May require you to update the people poster image to your style or request it in the style of the PMM defaults people posters |
#### DEBUG
This table details examples of the most commonly-seen `[DEBUG]` events and what they mean for the user.
| Type | Short Info | Description | Recommendation |
@ -16,6 +16,8 @@ Plex Meta Manager is an open source Python 3 project that has been designed to e
## Getting Started
## Getting Started
These are the high-level steps you must take to get Plex Meta Manager up and running:
1. Install Plex Meta Manager; this process is described [here](home/installation).
1. Install Plex Meta Manager; this process is described [here](home/installation).
2. Once installed, you have to create a [Configuration File](config/configuration), which contains URLs and credentials and the like which are used to connect to services like Plex and TMDb.
2. Once installed, you have to create a [Configuration File](config/configuration), which contains URLs and credentials and the like which are used to connect to services like Plex and TMDb.
@ -34,6 +36,10 @@ If you find steps 1-3 above daunting, there are some walkthroughs available that
## Development & Nightly Builds
## Development & Nightly Builds
Development and Nightly builds are deemed as "beta" builds which are updated far more frequently than the master branch. Bug fixes, new features and and any other code added to Plex Meta Manager first goes to the nightly branch, followed by the develop branch, before finally being released to the master branch.
The development builds (particularly the nightly branch) is only recommended for those who have a technical knowledge of Plex Meta Manager, and are happy with having to frequently update to receive the latest changes.
### Development
### Development
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
@ -42,29 +48,21 @@ The [develop](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) bran
Switching to `develop`:
Switching to `develop`:
````{tab} if running in Docker
````{tab} Running in Docker
<br/>
Add ":develop" to the image name in your run command or configuration:
Add ":develop" to the image name in your run command or configuration:
```
```
meisnate12/plex-meta-manager:develop
meisnate12/plex-meta-manager:develop
```
```
<br/>
````
````
````{tab} if running on the host:
````{tab} Running on the Host
In the directory where you cloned PMM:
In the directory where you cloned PMM:
```bash
```bash
git checkout develop
git checkout develop
```
```
To switch back:
To switch back:
```bash
```bash
git checkout master
git checkout master
```
```
<br/>
````
````
If switching to the develop build, it is recommended to also use the [develop branch of the wiki](https://metamanager.wiki/en/develop/), which documents any changes made from the Master build.
If switching to the develop build, it is recommended to also use the [develop branch of the wiki](https://metamanager.wiki/en/develop/), which documents any changes made from the Master build.
@ -75,33 +73,25 @@ If switching to the develop build, it is recommended to also use the [develop br
**This branch will have squashed commits which can cause `git pull`/`git fetch` to error you can use `git reset origin/nightly --hard` to fix the branch.**
**This branch will have squashed commits which can cause `git pull`/`git fetch` to error you can use `git reset origin/nightly --hard` to fix the branch.**
There is also a [nightly](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) build which will have the absolute latest version of the script, but it could easily break, there is no guarantee that it even works, and any new features will not be documented.
There is also a [nightly](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) build which will have the absolute latest version of the script, but it could easily break, there is no guarantee that it even works, and any new features will not be documented until they have progressed enough to reach the develop branch.
Switching to `nightly`:
Switching to `nightly`:
````{tab} if running in Docker
````{tab} Running in Docker
<br/>
Add ":nightly" to the image name in your run command or configuration:
Add ":nightly" to the image name in your run command or configuration:
meisnate12
2 years ago