Local-Installation.md

Testing has been done only on Python 3.7 and 3.8 on Linux and Windows. Dependencies must be installed by running:

pip install -r requirements.txt

If there are issues installing dependencies try:

pip install -r requirements.txt --ignore-installed

To run the script in an interactive terminal run:

python plex_meta_manager.py

Shell Commands

Name	Command	Allowed Values	Default Value
Config	-c or --config	Path to YAML config file	config/config.yml alongside plex_meta_manager.py
Time to Run	-t or --time	Time to update each day Format: HH:MM	03:00
Run	-r or --run	Run without the scheduler	False
Run Tests	-rt, --tests, or --run-tests	Run in debug mode with only collections that have test: true	False
Run Collections	-cl or --collections	Process only specified collections (comma-separated list)
Divider Character	-d or --divider	Character that divides the sections	=
Screen Width	-w or --width	Integer between 90 and 300	100

Config

To choose the location of the YAML config file

python plex_meta_manager.py --config <path_to_config>

Time to Run

To choose the time when the script will run each day

python plex_meta_manager.py --config /configs/config.yml --time 22:00

Run

To just run the script without having it continuously run use the --run option

python plex_meta_manager.py --config /configs/config.yml --run

Run Tests

To run the script in debug mode while only running collections that have test: true use the --run-tests option

python plex_meta_manager.py --config /configs/config.yml --run-tests

Run Collections

To have the script run only using the collections in the comma-separated list use the --collections option

python plex_meta_manager.py --config /configs/config.yml --collections "Harry Potter, Star Wars"

Divider Character & Screen Width

To change the terminal output divider character or width use --divider and --width

python plex_meta_manager.py --divider * --width 200