diff --git a/docs/home/guides/docker.md b/docs/home/guides/docker.md index ebe2e0d2..24800dae 100644 --- a/docs/home/guides/docker.md +++ b/docs/home/guides/docker.md @@ -47,6 +47,33 @@ You may want to take an hour to get familiar with Docker fundamentals with the [ 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 a7e9e649..34eebe5a 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. @@ -108,11 +95,15 @@ Follow the instructions here: [Installing Python 3 on Mac OS X](https://docs.pyt
```` ````{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. +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.
```` @@ -435,6 +426,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?