diff --git a/VERSION b/VERSION index 47a42753..2f94604e 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.18.0-develop55 +1.18.0-develop56 diff --git a/docs/home/guides/docker.md b/docs/home/guides/docker.md index 49d90cb7..29a48e2f 100644 --- a/docs/home/guides/docker.md +++ b/docs/home/guides/docker.md @@ -48,6 +48,33 @@ That’s a command you’re going to type or paste into your terminal (OSX or Li * 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. +### Prepare a small test library [optional] + +```{include} wt/wt-test-library.md +``` + +### Starting up your terminal. + +Since most of this is typing commands into a terminal, you'll need to have a terminal open. + +````{tab} Linux +
+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. +
+```` +````{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. + +You can also use iTerm or some other terminal app if you wish. If you don't know what that means, use Terminal. +
+```` +````{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. +
+```` + ### Installing Docker. To run Docker images, you need to have Docker installed. It is not typically installed on new Mac, Linux, or Windows machines. diff --git a/docs/home/guides/local.md b/docs/home/guides/local.md index 2a04f30d..6241d808 100644 --- a/docs/home/guides/local.md +++ b/docs/home/guides/local.md @@ -45,23 +45,10 @@ This walkthrough involves typing commands into a command window. On Mac OS X or IMPORTANT: This walkthrough is assuming you are doing the entire process on the same platform; i.e. you're installing PMM and editing its config files on a single Linux, Windows, or OS X machine. It doesn't account for situations like running PMM on a Linux machine while editing the config files on your Windows box. -### Prepare a small test library +### Prepare a small test library [optional] -While going through this process, Plex-Meta-Manager is going to load the movies in your library, create some collections, and apply some overlays. If you have a large library, this will be very time-consuming. - -For learning and testing, you would be well-advised to create a small test library of a reasonable size, where reasonable it probably below a thousand. - -The author has a small library of 10 movies that is used for fast tests. - -For best results, your test library will contain: - -At least two comedy movies released since 2012. -At least two movies from the IMDB top 250. -At least two movies from IMDB's Popular list. -At least two movies from IMDB's Lowest Rated. -A couple different resolutions among the movies. - -That will ensure there's something to go into each of the example collections that will be created. +```{include} wt/wt-test-library.md +``` ### Starting up your terminal. @@ -101,11 +88,15 @@ Describing a python install for any arbitrary linux is out of scope here, but if Follow the instructions here: [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/) ```` ````{tab} Windows -Go [here](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. +Go to http://www.python.org/download and download the next-to-latest minor 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, while the latest is 3.11. + +#### Why the next-to-latest? + +There is one dependency [`lxml`] that lags behind new Python releases; this will cause a failure when installing requirements in a moment if the newest Python version is too new [at time of writing the current is 3.11, and the requirements install fails on the lxml library]. You can avoid this by using the next-to-latest release. At some point this will no longer be a problem, but that is outside the control of PMM. 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 moment. ```` --- @@ -345,7 +336,7 @@ python -m pip install -r requirements.txt ``` You should see something like this [I’ve removed a few lines for space, and the specific versions may have changed since this was captured]: - +Studio: 441 and 1807 and 2495 and 1286 and 2503 and 2264 ``` Collecting PlexAPI==4.7.0 Downloading PlexAPI-4.7.0-py3-none-any.whl (133 kB) @@ -363,6 +354,28 @@ You should consider upgrading via the '/Users/mroche/Plex-Meta-Manager/pmm-venv/ Don't worry about the WARNING about `pip version thus-and-such` if it comes up. +
+ `Encountered error while trying to install package.` +
+ + If you see an error that ends in something like this: + +``` + ... + building 'lxml.etree' extension + error: Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools": https://visualstudio.microsoft.com/visual-cpp-build-tools/ + [end of output] + + note: This error originates from a subprocess, and is likely not a problem with pip. + error: legacy-install-failure + + × Encountered error while trying to install package. + ╰─> lxml +``` + You've hit the error we were referring to above with the Python version being too recent. Probably you are running Python 3.11 in late 2022 or Python 3.12 shortly after its release. Deactivate and delete the virtual environment and create one based on the previous Python release [which may involve removing Python and reinstalling the older version depending on platform], then try this step again. + +
+
What did that do? diff --git a/docs/home/guides/wt/wt-04-default-intro.md b/docs/home/guides/wt/wt-04-default-intro.md index ffb75d7a..88c05e0b 100644 --- a/docs/home/guides/wt/wt-04-default-intro.md +++ b/docs/home/guides/wt/wt-04-default-intro.md @@ -11,11 +11,11 @@ The default config links to two of them: The first will create: - Newly Released - New Episodes + - Newly Released + - New Episodes [TV libraries only] The second will create: - IMDb Popular - IMDb Top 250 - IMDb Lowest Rated + - IMDb Popular + - IMDb Top 250 + - IMDb Lowest Rated diff --git a/docs/home/guides/wt/wt-05-local-file.md b/docs/home/guides/wt/wt-05-local-file.md index 868fad43..aa57f1ea 100644 --- a/docs/home/guides/wt/wt-05-local-file.md +++ b/docs/home/guides/wt/wt-05-local-file.md @@ -3,31 +3,25 @@ If the default metadata files do not allow you to create the collections you wan First, open the metadata file [this will create the file if it doesn't already exist]: ````{tab} Linux -
[type this into your terminal] ``` nano "config/Movies.yml" ``` -
```` -````{tab} OS X: -
+````{tab} OS X [type this into your terminal] ``` nano "config/Movies.yml" ``` -
```` -````{tab} Windows: -
+````{tab} Windows [type this into your terminal] ``` notepad "config\Movies.yml" ``` -
```` In this file, add the following, exactly as it is shown here: diff --git a/docs/home/guides/wt/wt-10-scheduling.md b/docs/home/guides/wt/wt-10-scheduling.md index 9bc44334..f3934a00 100644 --- a/docs/home/guides/wt/wt-10-scheduling.md +++ b/docs/home/guides/wt/wt-10-scheduling.md @@ -1,13 +1,15 @@ -The commands you've been using in this walkthrough runn Plex-Meta-Manager immediately. +The commands you've been using in this walkthrough run Plex-Meta-Manager immediately then quit. -Plex Meta Manager also features multiple layers of scheduling, which you can leverage to +Plex Meta Manager also features multiple layers of scheduling, which you can leverage to control when various activities take place. -You can run PMM in the background, telling it to wake up and process your libraries at fixed times during the day. The default behavior in this regard is to wake up at 5AM and process the config. + - You can run PMM in the background, telling it to wake up and process your libraries at fixed times during the day. The default behavior in this regard is to wake up at 5AM and process the config. If you leave the `-r` off the commands you have been using in this walkthrough, that's what will happen. -You can skip using that internal schedule and just do manual runs as you have been doing throughout this walkthrough using standard tools available in your OS. + You can control when PMM wakes up with the [time-to-run](../../../home/environmental.md) env-var/runtime flag. -Details on setting this up are found [here](../scheduling.md). + - You can skip using that internal schedule and just do manual runs as you have been doing throughout this walkthrough using standard tools available in your OS. -In addition, individual items *within* the configuration can be scheduled to take place at certain times *provided PMM is running at that time*. For example, you can tell PMM only to apply overlays on Tuesdays or the like. YOu can then schedule manual runs every day at noon and overlays will only get processed when it runs on Tuesday. This sort of schedule *will not* make PMM start up if it is not already running. If you don't arrange for PMM to be run on Tuesday, your overlays would never be processed in this example. + Details on setting this up are found [here](../../../home/guides/scheduling.md). -Details on this level of scheduling are found [here](../../../metadata/details/schedule.md) + - In addition, individual items *within* the configuration can be scheduled to take place at certain times *provided PMM is running at that time*. For example, you can tell PMM only to apply overlays on Tuesdays or the like. YOu can then schedule manual runs every day at noon and overlays will only get processed when it runs on Tuesday. This sort of schedule *will not* make PMM start up if it is not already running. If you don't arrange for PMM to be run on Tuesday, your overlays would never be processed in this example. + + Details on this level of scheduling are found [here](../../../metadata/details/schedule.md) diff --git a/docs/home/guides/wt/wt-save.md b/docs/home/guides/wt/wt-save.md index 92c3d493..f7eb4d8d 100644 --- a/docs/home/guides/wt/wt-save.md +++ b/docs/home/guides/wt/wt-save.md @@ -2,7 +2,7 @@ If you're using `nano`, type control-`x`, then `y`, then the enter key. ```` ````{tab} OS X -If you're using `nano`, type control-`x`, then `y`, then the enter key.
+If you're using `nano`, type control-`x`, then `y`, then the enter key. ```` ````{tab} Windows If you're using `notepad`, type control-`s` or choose `Save` from the `File` menu. diff --git a/docs/home/guides/wt/wt-test-library.md b/docs/home/guides/wt/wt-test-library.md new file mode 100644 index 00000000..95992bf5 --- /dev/null +++ b/docs/home/guides/wt/wt-test-library.md @@ -0,0 +1,21 @@ +### Prepare a small test library [optional] + +While going through this process, Plex-Meta-Manager is going to load the movies in your library, create some collections, and apply some overlays. If you have a large library, this will be very time-consuming. + +For learning and testing, you would be well-advised to create a small test library of a reasonable size, where reasonable it probably below a thousand. + +The author has a small library of 10 movies that is used for fast tests. + +For best results with this walkthrough, your test library will contain: + + - At least two comedy movies released since 2012. + - At least two movies from the [IMDB top 250](https://www.imdb.com/chart/top/). + - At least two movies from [IMDB's Popular list](https://www.imdb.com/chart/moviemeter). + - At least two movies from [IMDB's Lowest Rated](https://www.imdb.com/chart/bottom). + - A couple different resolutions among the movies. + +That will ensure there's something to go into each of the example collections that will be created. + +The advantage of the small test library is that it will reduce the time needed to see results. Running some of these default collections against a library of a few thousand movies can take hours, and for iterative testing it's useful to have something that will run in a few minutes or seconds. + +You can set up a test library like this using symlinks without copying files.