wiki update 1.5.1

master
meisnate12 3 years ago
parent 901c79e85f
commit 46e4922f45

134
.gitignore vendored

@ -0,0 +1,134 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.idea
.Python
/test.py
logs/
config/*
!config/*.template
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
.python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/

@ -3,7 +3,7 @@ You can build different collections using the features of [AniDB.net](https://an
No configuration is required for these builders. No configuration is required for these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [AniDB ID](#anidb-id) | `anidb_id` | Gets the anime specified by the AniDB ID | :heavy_check_mark: | :heavy_check_mark: | | [AniDB ID](#anidb-id) | `anidb_id` | Gets the anime specified by the AniDB ID | :heavy_check_mark: | :heavy_check_mark: |
| [AniDB Relation](#anidb-relation) | `anidb_relation` | Gets all anime in the relation graph of the specified AniDB ID | :heavy_check_mark: | :heavy_check_mark: | | [AniDB Relation](#anidb-relation) | `anidb_relation` | Gets all anime in the relation graph of the specified AniDB ID | :heavy_check_mark: | :heavy_check_mark: |
| [AniDB Popular](#anidb-popular) | `anidb_popular` | Gets every anime in AniDB's [Popular Anime](https://anidb.net/latest/anime/popular/?h=1) list | :heavy_check_mark: | :heavy_check_mark: | | [AniDB Popular](#anidb-popular) | `anidb_popular` | Gets every anime in AniDB's [Popular Anime](https://anidb.net/latest/anime/popular/?h=1) list | :heavy_check_mark: | :heavy_check_mark: |

@ -3,7 +3,7 @@ You can build different collections using the features of [AniList.co](https://a
No configuration is required for these builders. No configuration is required for these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [AniList Top Rated Anime](#anilist-top-rated-anime) | `anilist_popular` | Gets every anime in AniList's [Top Rated Anime](https://anilist.co/search/anime?sort=SCORE_DESC) list | :heavy_check_mark: | :heavy_check_mark: | | [AniList Top Rated Anime](#anilist-top-rated-anime) | `anilist_popular` | Gets every anime in AniList's [Top Rated Anime](https://anilist.co/search/anime?sort=SCORE_DESC) list | :heavy_check_mark: | :heavy_check_mark: |
| [AniList Popular Anime](#anilist-popular-anime) | `anilist_popular` | Gets every anime in AniList's [Popular Anime](https://anilist.co/search/anime?sort=POPULARITY_DESC) list | :heavy_check_mark: | :heavy_check_mark: | | [AniList Popular Anime](#anilist-popular-anime) | `anilist_popular` | Gets every anime in AniList's [Popular Anime](https://anilist.co/search/anime?sort=POPULARITY_DESC) list | :heavy_check_mark: | :heavy_check_mark: |
| [AniList Seasonal Anime](#anilist-seasonal-anime) | `anilist_season` | Gets anime in AniList's Seasonal Anime list the options are detailed below | :heavy_check_mark: | :heavy_check_mark: | | [AniList Seasonal Anime](#anilist-seasonal-anime) | `anilist_season` | Gets anime in AniList's Seasonal Anime list the options are detailed below | :heavy_check_mark: | :heavy_check_mark: |
@ -43,7 +43,7 @@ collections:
Gets anime in AniList's Seasonal Anime list the options are detailed below.. Gets anime in AniList's Seasonal Anime list the options are detailed below..
| Attribute | Description | Required | Default | | Attribute | Description | Required | Default |
| :-- | :-- | :--: | :--: | | :--- | :--- | :---: | :---: |
| `season` | `winter` (For winter season December, January, February)<br>`spring` (For spring season March, April, May)<br>`summer` (For summer season June, July, August)<br>`fall` (For fall season September, October, November) | :x: | Current Season | | `season` | `winter` (For winter season December, January, February)<br>`spring` (For spring season March, April, May)<br>`summer` (For summer season June, July, August)<br>`fall` (For fall season September, October, November) | :x: | Current Season |
| `year` | 4 digit integer year between 1917-Current | :x: | Current Year | | `year` | 4 digit integer year between 1917-Current | :x: | Current Year |
| `sort_by` | `score` (Sort by Score)<br>`popular` (Sort by Most Popular) | :x: | `score` | | `sort_by` | `score` (Sort by Score)<br>`popular` (Sort by Most Popular) | :x: | `score` |

@ -57,7 +57,7 @@ The available collection details attributes for each collection are split into d
All the following attributes serve various functions as how the collection functions inside of Plex Meta Manager. All the following attributes serve various functions as how the collection functions inside of Plex Meta Manager.
| Name | Attribute | Description | Allowed Values | | Name | Attribute | Description | Allowed Values |
| :-- | :-- | :-- | :-- | | :--- | :--- | :--- | :--- |
| Schedule | `schedule` | Used to schedule this collection | [`schedule` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Attribute) | | Schedule | `schedule` | Used to schedule this collection | [`schedule` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Attribute) |
| Template | `template` | Used to specify a template and template variables to use for this collection | [`template` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) | | Template | `template` | Used to specify a template and template variables to use for this collection | [`template` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) |
| Run Again | `run_again` | Used to try and add all the items missing from the collection to the collection again after the daily run. | **boolean:** `true` or `false` | | Run Again | `run_again` | Used to try and add all the items missing from the collection to the collection again after the daily run. | **boolean:** `true` or `false` |
@ -68,7 +68,7 @@ All the following attributes serve various functions as how the collection funct
| Show Missing Collections | `show_missing` | Collection level `show_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` | | Show Missing Collections | `show_missing` | Collection level `show_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
| Save Missing Collections | `save_missing` | Collection level `save_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` | | Save Missing Collections | `save_missing` | Collection level `save_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
| Name Mapping | `name_mapping` | Used to specify the folder name in the [Image Assets Directory](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes#image-asset-directory) | Folder Name In Assets Directory | | Name Mapping | `name_mapping` | Used to specify the folder name in the [Image Assets Directory](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes#image-asset-directory) | Folder Name In Assets Directory |
| Test Mode | `test` | When running in Test Mode (`--run-tests` [option](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Local-Installation#run-tests)) only collections with `test: true` will be run<br>**Default:** false | **boolean:** `true` or `false` | | Test Mode | `test` | When running in Test Mode (`---run-tests` [option](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Local-Installation#run-tests)) only collections with `test: true` will be run<br>**Default:** false | **boolean:** `true` or `false` |
* **Name Mapping:** If your collection name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*` cannot be in the file path) but you want them in your collection name you can use the `name_mapping` attribute to specific this collection's name in the file system. * **Name Mapping:** If your collection name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*` cannot be in the file path) but you want them in your collection name you can use the `name_mapping` attribute to specific this collection's name in the file system.
@ -76,7 +76,7 @@ All the following attributes serve various functions as how the collection funct
All the following attributes update various details of the collection's Metadata. All the following attributes update various details of the collection's Metadata.
| Name | Attribute | Description | Allowed Values | | Name | Attribute | Description | Allowed Values |
| :-- | :-- | :-- | :-- | | :--- | :--- | :--- | :--- |
| TMDb Person | `tmdb_person` | Used to change the collection's summary and poster to a TMDb Person's biography and profile as well as allow the people specified to be used in [Plex Searches](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Builders#plex-search) | TMDb Person ID (List or Comma-separated string) | | TMDb Person | `tmdb_person` | Used to change the collection's summary and poster to a TMDb Person's biography and profile as well as allow the people specified to be used in [Plex Searches](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Builders#plex-search) | TMDb Person ID (List or Comma-separated string) |
| Sort Title | `sort_title` | Used to change the collection's sort title | Text to change Sort Title | | Sort Title | `sort_title` | Used to change the collection's sort title | Text to change Sort Title |
| Content Rating | `content_rating` | Used to change the collection's content rating | Text to change Content Rating | | Content Rating | `content_rating` | Used to change the collection's content rating | Text to change Content Rating |
@ -93,7 +93,7 @@ All the following attributes update various details of the collection's Metadata
All the following attributes update the summary of the collection from various sources. All the following attributes update the summary of the collection from various sources.
| Name | Attribute | Description | Allowed Values | | Name | Attribute | Description | Allowed Values |
| :-- | :-- | :-- | :-- | | :--- | :--- | :--- | :--- |
| Summary | `summary` | Used to change the collection's summary | Text to change Summary | | Summary | `summary` | Used to change the collection's summary | Text to change Summary |
| TMDb Summary | `tmdb_summary` | Used to change the collection's summary to the TMDb Movie/Collection summary for a movie library or the TMDb Show summary for a show library | TMDb Movie/Show/Collection ID | | TMDb Summary | `tmdb_summary` | Used to change the collection's summary to the TMDb Movie/Collection summary for a movie library or the TMDb Show summary for a show library | TMDb Movie/Show/Collection ID |
| TMDb Description | `tmdb_description` | Used to change the collection's summary to the TMDb List Description | TMDb List ID | | TMDb Description | `tmdb_description` | Used to change the collection's summary to the TMDb List Description | TMDb List ID |
@ -107,7 +107,7 @@ All the following attributes update the summary of the collection from various s
All the following attributes update the poster of the collection from various sources. All the following attributes update the poster of the collection from various sources.
| Name | Attribute | Description | Allowed Values | | Name | Attribute | Description | Allowed Values |
| :-- | :-- | :-- | :-- | | :--- | :--- | :--- | :--- |
| URL Poster<sup>2</sup> | `url_poster` | Used to change the collection's poster to the URL | URL of image publicly available on the internet | | URL Poster<sup>2</sup> | `url_poster` | Used to change the collection's poster to the URL | URL of image publicly available on the internet |
| TMDb Poster<sup>2</sup> | `tmdb_poster` | Used to change the collection's poster to the TMDb Movie/Collection poster for a movie library or the TMDb Show poster for a show library | TMDb Movie/Show/Collection ID | | TMDb Poster<sup>2</sup> | `tmdb_poster` | Used to change the collection's poster to the TMDb Movie/Collection poster for a movie library or the TMDb Show poster for a show library | TMDb Movie/Show/Collection ID |
| TMDb List Poster<sup>2</sup> | `tmdb_list_poster` | Used to change the collection's poster to the TMDb List poster | TMDb List ID | | TMDb List Poster<sup>2</sup> | `tmdb_list_poster` | Used to change the collection's poster to the TMDb List poster | TMDb List ID |
@ -121,7 +121,7 @@ All the following attributes update the poster of the collection from various so
All the following attributes update the background of the collection from various sources. All the following attributes update the background of the collection from various sources.
| Name | Attribute | Description | Allowed Values | | Name | Attribute | Description | Allowed Values |
| :-- | :-- | :-- | :-- | | :--- | :--- | :--- | :--- |
| URL Background<sup>3</sup> | `url_background` | Use to change the collection's background to the URL | URL of image publicly available on the internet | | URL Background<sup>3</sup> | `url_background` | Use to change the collection's background to the URL | URL of image publicly available on the internet |
| TMDb Background<sup>3</sup> | `tmdb_background` | Used to change the collection's background to the TMDb Movie/Collection background for a movie library or the TMDb Show background for a show library | TMDb Movie/Show/Collection ID | | TMDb Background<sup>3</sup> | `tmdb_background` | Used to change the collection's background to the TMDb Movie/Collection background for a movie library or the TMDb Show background for a show library | TMDb Movie/Show/Collection ID |
| TVDb Background<sup>3</sup> | `tvdb_background` | Used to change the collection's background to the TVDb Movie background for a movie library or the TVDb Show background for a show library | TVDb Movie/Show ID or URL | | TVDb Background<sup>3</sup> | `tvdb_background` | Used to change the collection's background to the TVDb Movie background for a movie library or the TVDb Show background for a show library | TVDb Movie/Show ID or URL |

@ -7,7 +7,7 @@ All collection filter options are listed below. To display collections filtered
### Standard Filters ### Standard Filters
| Standard Filters | Description | Movie<br>Libraries | Show<br>Libraries | | Standard Filters | Description | Movie<br>Libraries | Show<br>Libraries |
| :-- | :-- | :--: | :--: | | :--- | :--- | :---: | :---: |
| `actor` | Matches every movie/show with the specified actor | :heavy_check_mark: | :heavy_check_mark: | | `actor` | Matches every movie/show with the specified actor | :heavy_check_mark: | :heavy_check_mark: |
| `collection` | Matches every movie/show with the specified plex collection | :heavy_check_mark: | :heavy_check_mark: | | `collection` | Matches every movie/show with the specified plex collection | :heavy_check_mark: | :heavy_check_mark: |
| `content_rating` | Matches every movie/show with the specified content rating | :heavy_check_mark: | :heavy_check_mark: | | `content_rating` | Matches every movie/show with the specified content rating | :heavy_check_mark: | :heavy_check_mark: |
@ -30,7 +30,7 @@ All collection filter options are listed below. To display collections filtered
### Advanced Filters ### Advanced Filters
| Advanced Filters | Description | Movie<br>Libraries | Show<br>Libraries | | Advanced Filters | Description | Movie<br>Libraries | Show<br>Libraries |
| :-- | :-- | :--: | :--: | | :--- | :--- | :---: | :---: |
| `max_age` | Matches any movie/show whose Originally Available date is within the last specified number of days | :heavy_check_mark: | :heavy_check_mark: | | `max_age` | Matches any movie/show whose Originally Available date is within the last specified number of days | :heavy_check_mark: | :heavy_check_mark: |
| `year.gte` | Matches any movie/show whose year is greater then or equal to the specified year | :heavy_check_mark: | :heavy_check_mark: | | `year.gte` | Matches any movie/show whose year is greater then or equal to the specified year | :heavy_check_mark: | :heavy_check_mark: |
| `year.lte` | Matches any movie/show whose year is less then or equal to the specified year | :heavy_check_mark: | :heavy_check_mark: | | `year.lte` | Matches any movie/show whose year is less then or equal to the specified year | :heavy_check_mark: | :heavy_check_mark: |

@ -1,8 +1,9 @@
The script utilizes a YAML config file to load information to connect to the various APIs you can connect with. The script utilizes a YAML config file to load information to connect to the various APIs you can connect with.
The YAML mappings that can be set in the configuration file's root: The YAML mappings that can be set in the configuration file's root:
| Name | YAML Attribute | Required | | Name | YAML Attribute | Required |
| :-- | :-- | :--: | | :--- | :--- | :---: |
| [Libraries](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Libraries-Attributes) | `libraries` | :heavy_check_mark: | | [Libraries](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Libraries-Attributes) | `libraries` | :heavy_check_mark: |
| [Settings](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | `settings` | :x: | | [Settings](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | `settings` | :x: |
| [Plex](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Attributes) | `plex` | :x: | | [Plex](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Attributes) | `plex` | :x: |

@ -17,17 +17,19 @@ docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex
``` ```
### Shell Commands ### Commands
| Name | Command | Allowed Values | Default Value | | Name | Shell Command | Environmental<br>Variable | Allowed Values | Default Value |
| :-- | :-- | :-- | :-- | | :--- | :--- | :--- | :--- | :--- |
| [Config](#config) | `-c` or `--config` | Path to YAML config file | `config/config.yml` alongside<br>`plex_meta_manager.py` | | [Config](#config) | `-c` or `--config` | `PMM_CONFIG` | Path to YAML config file | `config/config.yml` alongside<br>`plex_meta_manager.py` |
| [Time to Run](#time-to-run) | `-t` or `--time` | Time to update each day<br>**Format:** HH:MM | `03:00` | | [Time to Run](#time-to-run) | `-t` or `--time` | `PMM_TIME` | Time to update each day<br>**Format:** HH:MM | `03:00` |
| [Run](#run) | `-r` or `--run` | Run without the scheduler | `False` | | [Run](#run) | `-r` or `--run` | `PMM_RUN` | Run without the scheduler | `False` |
| [Run Tests](#run-tests) | `-rt`, `--tests`, or `--run-tests` | Run in debug mode with only collections that have `test: true` | `False` | | [Run Tests](#run-tests) | `-rt`, `--tests`, or `--run-tests` | `PMM_TEST` | Run in debug mode with only collections that have `test: true` | `False` |
| [Run Collections](#run-collections) | `-cl` or `--collections` | Process only specified collections (comma-separated list) | ` ` | | [Run Collections](#run-collections) | `-cl` or `--collections` | `PMM_COLLECTIONS` | Process only specified collections (comma-separated list) | ` ` |
| [Divider Character](#divider-character--screen-width) | `-d` or `--divider` | Character that divides the sections | `=` | | [Divider Character](#divider-character--screen-width) | `-d` or `--divider` | `PMM_DIVIDER` | Character that divides the sections | `=` |
| [Screen Width](#divider-character--screen-width) | `-w` or `--width` | Integer between 90 and 300 | `100` | | [Screen Width](#divider-character--screen-width) | `-w` or `--width` | `PMM_WIDTH` | Integer between 90 and 300 | `100` |
* Environmental Variable values are used over Shell Command values
## Config ## Config
To choose the location of the YAML config file To choose the location of the YAML config file

@ -16,8 +16,9 @@ metadata:
``` ```
The available attributes for each episode are as follows The available attributes for each episode are as follows
| Name | Attribute | Allowed Values | | Name | Attribute | Allowed Values |
| :-- | :-- | :-- | | :--- | :--- | :--- |
| Title | `title` | Text to change Title | | Title | `title` | Text to change Title |
| Sort Title | `sort_title` | Text to change Sort Title | | Sort Title | `sort_title` | Text to change Sort Title |
| Originally Available | `originally_available` | Date to change Originally Available<br><strong>Format:</strong> YYYY-MM-DD | | Originally Available | `originally_available` | Date to change Originally Available<br><strong>Format:</strong> YYYY-MM-DD |

@ -1,7 +1,7 @@
You can build different collections using the features of [IMDb.com](https://www.imdb.com/) (IMDb). You can build different collections using the features of [IMDb.com](https://www.imdb.com/) (IMDb).
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [IMDb ID](#imdb-id) | `imdb_id` | Gets the movie/show specified | :heavy_check_mark: | :heavy_check_mark: | | [IMDb ID](#imdb-id) | `imdb_id` | Gets the movie/show specified | :heavy_check_mark: | :heavy_check_mark: |
| [IMDb List](#imdb-list) | `imdb_list` | Gets every movie/show in an IMDb List or [IMDb Search](https://www.imdb.com/search/title/) | :heavy_check_mark: | :heavy_check_mark: | | [IMDb List](#imdb-list) | `imdb_list` | Gets every movie/show in an IMDb List or [IMDb Search](https://www.imdb.com/search/title/) | :heavy_check_mark: | :heavy_check_mark: |

@ -3,7 +3,7 @@ You can build different collections using the lists on [Letterboxd.com](https://
No configuration is required for these builders. No configuration is required for these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [Letterboxd List](#letterboxd-list) | `letterboxd_list` | Gets every movie in the Letterboxd List | :heavy_check_mark: | :x: | | [Letterboxd List](#letterboxd-list) | `letterboxd_list` | Gets every movie in the Letterboxd List | :heavy_check_mark: | :x: |
| [Letterboxd List Details ](#letterboxd-list) | `letterboxd_list_details` | Gets every movie in the Letterboxd List and updates the collection with the description of the Letterboxd list | :heavy_check_mark: | :x: | | [Letterboxd List Details ](#letterboxd-list) | `letterboxd_list_details` | Gets every movie in the Letterboxd List and updates the collection with the description of the Letterboxd list | :heavy_check_mark: | :x: |

@ -17,8 +17,9 @@ plex:
``` ```
The available attributes for each library are as follows The available attributes for each library are as follows
| Name | Attribute | Allowed Values | Default | Required | | Name | Attribute | Allowed Values | Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| Library Type | `library_type` | `movie` (For Movie Libraries)<br>`show` (For Show Libraries) | N/A | :heavy_check_mark: | | Library Type | `library_type` | `movie` (For Movie Libraries)<br>`show` (For Show Libraries) | N/A | :heavy_check_mark: |
| Library Name | `library_name` | Library name (Only needed when trying to use multiple libraries with the same name) | Base Attribute Name | :x: | | Library Name | `library_name` | Library name (Only needed when trying to use multiple libraries with the same name) | Base Attribute Name | :x: |
| Metadata Path | `metadata_path` | System Location for the Metadata YAML file | Same directory as config YAML file | :x: | | Metadata Path | `metadata_path` | System Location for the Metadata YAML file | Same directory as config YAML file | :x: |

@ -16,17 +16,19 @@ To run the script in an interactive terminal run:
python plex_meta_manager.py python plex_meta_manager.py
``` ```
### Shell Commands ### Commands
| Name | Command | Allowed Values | Default Value | | Name | Shell Command | Environmental<br>Variable | Allowed Values | Default Value |
| :-- | :-- | :-- | :-- | | :--- | :--- | :--- | :--- | :--- |
| [Config](#config) | `-c` or `--config` | Path to YAML config file | `config/config.yml` alongside<br>`plex_meta_manager.py` | | [Config](#config) | `-c` or `--config` | `PMM_CONFIG` | Path to YAML config file | `config/config.yml` alongside<br>`plex_meta_manager.py` |
| [Time to Run](#time-to-run) | `-t` or `--time` | Time to update each day<br>**Format:** HH:MM | `03:00` | | [Time to Run](#time-to-run) | `-t` or `--time` | `PMM_TIME` | Time to update each day<br>**Format:** HH:MM | `03:00` |
| [Run](#run) | `-r` or `--run` | Run without the scheduler | `False` | | [Run](#run) | `-r` or `--run` | `PMM_RUN` | Run without the scheduler | `False` |
| [Run Tests](#run-tests) | `-rt`, `--tests`, or `--run-tests` | Run in debug mode with only collections that have `test: true` | `False` | | [Run Tests](#run-tests) | `-rt`, `--tests`, or `--run-tests` | `PMM_TEST` | Run in debug mode with only collections that have `test: true` | `False` |
| [Run Collections](#run-collections) | `-cl` or `--collections` | Process only specified collections (comma-separated list) | ` ` | | [Run Collections](#run-collections) | `-cl` or `--collections` | `PMM_COLLECTIONS` | Process only specified collections (comma-separated list) | ` ` |
| [Divider Character](#divider-character--screen-width) | `-d` or `--divider` | Character that divides the sections | `=` | | [Divider Character](#divider-character--screen-width) | `-d` or `--divider` | `PMM_DIVIDER` | Character that divides the sections | `=` |
| [Screen Width](#divider-character--screen-width) | `-w` or `--width` | Integer between 90 and 300 | `100` | | [Screen Width](#divider-character--screen-width) | `-w` or `--width` | `PMM_WIDTH` | Integer between 90 and 300 | `100` |
* Environmental Variable values are used over Shell Command values
## Config ## Config
To choose the location of the YAML config file To choose the location of the YAML config file

@ -37,8 +37,9 @@ metadata:
``` ```
The available attributes for each movie/show are as follows The available attributes for each movie/show are as follows
| Name | Attribute | Allowed Values | Works with Movies | Works with Shows | | Name | Attribute | Allowed Values | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| Title | `title` | Title if different from the mapping value useful when you have multiple movies with the same name | :heavy_check_mark: | :heavy_check_mark: | | Title | `title` | Title if different from the mapping value useful when you have multiple movies with the same name | :heavy_check_mark: | :heavy_check_mark: |
| Alternative Title | `alt_title` | Alternative title to look for | :heavy_check_mark: | :heavy_check_mark: | | Alternative Title | `alt_title` | Alternative title to look for | :heavy_check_mark: | :heavy_check_mark: |
| Year | `year` | Year of movie/show for better identification | :heavy_check_mark: | :heavy_check_mark: | | Year | `year` | Year of movie/show for better identification | :heavy_check_mark: | :heavy_check_mark: |

@ -27,8 +27,9 @@ Anime.yml
``` ```
There are three mappings allowed in the Metadata File's root: There are three mappings allowed in the Metadata File's root:
| Name | Attribute | Description | | Name | Attribute | Description |
| :-- | :-- | :-- | | :--- | :--- | :--- |
| [Metadata](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Metadata-Attributes) | `metadata` | mapping where metadata changes go | | [Metadata](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Metadata-Attributes) | `metadata` | mapping where metadata changes go |
| [Templates](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) | `templates` | mapping where templates for automatic collections go | | [Templates](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) | `templates` | mapping where templates for automatic collections go |
| [Collections](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Attributes) | `collections` | mapping where automatic collections and collection metadata go | | [Collections](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Attributes) | `collections` | mapping where automatic collections and collection metadata go |

@ -15,7 +15,7 @@ mal:
``` ```
| Name | Attribute | Allowed Values | Default | Required | | Name | Attribute | Allowed Values | Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| Client ID | `client_id` | MyAnimeList Application Client ID | N/A | :heavy_check_mark: | | Client ID | `client_id` | MyAnimeList Application Client ID | N/A | :heavy_check_mark: |
| Client Secret | `client_secret` | MyAnimeList Application Client Secret | N/A | :heavy_check_mark: | | Client Secret | `client_secret` | MyAnimeList Application Client Secret | N/A | :heavy_check_mark: |

@ -3,7 +3,7 @@ You can build different collections using the features of [MyAnimeList.net](http
[Configuring MyAnimeList](https://github.com/meisnate12/Plex-Meta-Manager/wiki/MyAnimeList-Attributes) in the config is required for any of these builders. [Configuring MyAnimeList](https://github.com/meisnate12/Plex-Meta-Manager/wiki/MyAnimeList-Attributes) in the config is required for any of these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [MyAnimeList Top All Anime](#myanimelist-top-all-anime) | `mal_all` | Gets every anime in MyAnimeList's [Top All Anime](https://myanimelist.net/topanime.php) list | :heavy_check_mark: | :heavy_check_mark: | [MyAnimeList Top All Anime](#myanimelist-top-all-anime) | `mal_all` | Gets every anime in MyAnimeList's [Top All Anime](https://myanimelist.net/topanime.php) list | :heavy_check_mark: | :heavy_check_mark:
| [MyAnimeList Top Airing Anime](#myanimelist-top-airing-anime) | `mal_airing` | Gets every anime in MyAnimeList's [Top Airing Anime](https://myanimelist.net/topanime.php?type=airing) list | :heavy_check_mark: | :heavy_check_mark: | | [MyAnimeList Top Airing Anime](#myanimelist-top-airing-anime) | `mal_airing` | Gets every anime in MyAnimeList's [Top Airing Anime](https://myanimelist.net/topanime.php?type=airing) list | :heavy_check_mark: | :heavy_check_mark: |
| [MyAnimeList Top Upcoming Anime](#myanimelist-top-upcoming-anime) | `mal_upcoming` | Gets every anime in MyAnimeList's [Top Upcoming Anime](https://myanimelist.net/topanime.php?type=upcoming) list | :heavy_check_mark: | :heavy_check_mark: | | [MyAnimeList Top Upcoming Anime](#myanimelist-top-upcoming-anime) | `mal_upcoming` | Gets every anime in MyAnimeList's [Top Upcoming Anime](https://myanimelist.net/topanime.php?type=upcoming) list | :heavy_check_mark: | :heavy_check_mark: |
@ -150,7 +150,7 @@ collections:
Gets anime in MyAnimeList User's Anime list. The different sub-attributes are detailed below. Gets anime in MyAnimeList User's Anime list. The different sub-attributes are detailed below.
| Attribute | Description | Required | Default | | Attribute | Description | Required | Default |
| :-- | :-- | :--: | :--: | | :--- | :--- | :---: | :---: |
| `username` | A user's MyAnimeList Username or `@me` for the authorized user | :heavy_check_mark: | N/A | | `username` | A user's MyAnimeList Username or `@me` for the authorized user | :heavy_check_mark: | N/A |
| `status` | `all` (All Anime List)<br>`watching` (Currently Watching List)<br>`completed` (Completed List)<br>`on_hold` (On Hold List)<br>`dropped` (Dropped List)<br>`plan_to_watch` (Plan to Watch) | :x: | `all` | | `status` | `all` (All Anime List)<br>`watching` (Currently Watching List)<br>`completed` (Completed List)<br>`on_hold` (On Hold List)<br>`dropped` (Dropped List)<br>`plan_to_watch` (Plan to Watch) | :x: | `all` |
| `sort_by` | `score` (Sort by Score)<br>`last_updated` (Sort by Last Updated)<br>`title` (Sort by Anime Title)<br>`start_date` (Sort by Start Date) | :x: | `score` | | `sort_by` | `score` (Sort by Score)<br>`last_updated` (Sort by Last Updated)<br>`title` (Sort by Anime Title)<br>`start_date` (Sort by Start Date) | :x: | `score` |
@ -171,7 +171,7 @@ collections:
Gets anime in MyAnimeList's [Seasonal Anime](https://myanimelist.net/anime/season) list the options are detailed below. Gets anime in MyAnimeList's [Seasonal Anime](https://myanimelist.net/anime/season) list the options are detailed below.
| Attribute | Description | Required | Default | | Attribute | Description | Required | Default |
| :-- | :-- | :--: | :--: | | :--- | :--- | :---: | :---: |
| `season` | `winter` (For winter season January, February, March)<br>`spring` (For spring season April, May, June)<br>`summer` (For summer season July, August, September)<br>`fall` (For fall season October, November, December) | :x: | Current Season | | `season` | `winter` (For winter season January, February, March)<br>`spring` (For spring season April, May, June)<br>`summer` (For summer season July, August, September)<br>`fall` (For fall season October, November, December) | :x: | Current Season |
| `year` | 4 digit integer year between 1917-Current | :x: | Current Year | | `year` | 4 digit integer year between 1917-Current | :x: | Current Year |
| `sort_by` | `members` (Sort by Most Members)<br>`score` (Sort by Score) | :x: | `members` | | `sort_by` | `members` (Sort by Most Members)<br>`score` (Sort by Score) | :x: | `members` |

@ -9,7 +9,7 @@ omdb:
``` ```
| Name | Attribute | Allowed Values | Default | Required | | Name | Attribute | Allowed Values | Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| API Key | `apikey` | OMDb API Key | N/A | :heavy_check_mark: | | API Key | `apikey` | OMDb API Key | N/A | :heavy_check_mark: |
* The OMDb apikey can be generated [here](http://www.omdbapi.com/apikey.aspx). * The OMDb apikey can be generated [here](http://www.omdbapi.com/apikey.aspx).

@ -11,7 +11,7 @@ plex:
``` ```
| Name | Attribute | Allowed Values | Default | Required | | Name | Attribute | Allowed Values | Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| Server URL | `url` | Plex Server URL<br><strong>Example:</strong> http://192.168.1.12:32400 | N/A | :heavy_check_mark: | | Server URL | `url` | Plex Server URL<br><strong>Example:</strong> http://192.168.1.12:32400 | N/A | :heavy_check_mark: |
| Authentication Token | `token` | Plex Server Authentication Token | N/A | :heavy_check_mark: | | Authentication Token | `token` | Plex Server Authentication Token | N/A | :heavy_check_mark: |
| Plex Timeout | `timeout` | Plex Server Timeout | 60 | :x: | | Plex Timeout | `timeout` | Plex Server Timeout | 60 | :x: |

@ -16,7 +16,7 @@ radarr:
``` ```
| Name | Attribute | Allowed Values| Default | Required | | Name | Attribute | Allowed Values| Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| Radarr URL | `url` | Radarr URL<br><strong>Example:</strong> http://192.168.1.12:32788 | N/A | :heavy_check_mark: | | Radarr URL | `url` | Radarr URL<br><strong>Example:</strong> http://192.168.1.12:32788 | N/A | :heavy_check_mark: |
| API Token | `token` | Radarr API Token | N/A | :heavy_check_mark: | | API Token | `token` | Radarr API Token | N/A | :heavy_check_mark: |
| Radarr Version | `version` | `v2`: for < 0.2<br>`v3`: for > 3.0 | v2 | :x: | | Radarr Version | `version` | `v2`: for < 0.2<br>`v3`: for > 3.0 | v2 | :x: |

@ -14,8 +14,9 @@ collections:
``` ```
The scheduling options are: The scheduling options are:
| Name | Description | Format | Example | | Name | Description | Format | Example |
| :-- | :-- | :-- | :-- | | :--- | :--- | :--- | :--- |
| Daily | Update this collection once a day | daily | daily | | Daily | Update this collection once a day | daily | daily |
| Weekly | Update this collection once a week on the specified day | weekly(Day of Week) | weekly(sunday) | | Weekly | Update this collection once a week on the specified day | weekly(Day of Week) | weekly(sunday) |
| Monthly | Update this collection once a month on the specified day | monthly(Day of Month) | monthly(1) | | Monthly | Update this collection once a month on the specified day | monthly(Day of Month) | monthly(1) |

@ -39,6 +39,6 @@ metadata:
The available attributes for each season are as follows The available attributes for each season are as follows
| Name | Attribute | Allowed Values | | Name | Attribute | Allowed Values |
| :-- | :-- | :-- | | :--- | :--- | :--- |
| Title | `title` | Text to change Title | | Title | `title` | Text to change Title |
| Summary | `summary` | Text to change Summary | | Summary | `summary` | Text to change Summary |

@ -17,7 +17,7 @@ settings:
``` ```
| Name | Attribute | Allowed Values | Default | Global Level | Library Level | Collection Level | | Name | Attribute | Allowed Values | Default | Global Level | Library Level | Collection Level |
| :-- | :-- | :-- | :--: | :--: | :--: | :--: | | :--- | :--- | :--- | :---: | :---: | :---: | :---: |
| Cache | `cache` | Should the script store a cache<br><strong>boolean:</strong> true or false | true | :heavy_check_mark: | :x: | :x: | | Cache | `cache` | Should the script store a cache<br><strong>boolean:</strong> true or false | true | :heavy_check_mark: | :x: | :x: |
| Cache Expiration | `cache_expiration` | Number of days before each cache mapping expires and has to be reloaded | 60 | :heavy_check_mark: | :x: | :x: | | Cache Expiration | `cache_expiration` | Number of days before each cache mapping expires and has to be reloaded | 60 | :heavy_check_mark: | :x: | :x: |
| [Image Asset Directory](#image-asset-directory) | `asset_directory` | System Locations For Image Assets | [Directory containing YAML config]/assets | :heavy_check_mark: | :heavy_check_mark: | :x: | | [Image Asset Directory](#image-asset-directory) | `asset_directory` | System Locations For Image Assets | [Directory containing YAML config]/assets | :heavy_check_mark: | :heavy_check_mark: | :x: |

@ -17,7 +17,7 @@ sonarr:
``` ```
| Name | Attribute | Allowed Values| Default | Required | | Name | Attribute | Allowed Values| Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| Sonarr URL | `url` | Sonarr URL<br><strong>Example:</strong> http://192.168.1.12:32788 | N/A | :heavy_check_mark: | | Sonarr URL | `url` | Sonarr URL<br><strong>Example:</strong> http://192.168.1.12:32788 | N/A | :heavy_check_mark: |
| API Token | `token` | Sonarr API Token | N/A | :heavy_check_mark: | | API Token | `token` | Sonarr API Token | N/A | :heavy_check_mark: |
| Sonarr Version | `version` | `v2`: for < 0.2<br>`v3`: for > 3.0 | v2 | :x: | | Sonarr Version | `version` | `v2`: for < 0.2<br>`v3`: for > 3.0 | v2 | :x: |

@ -10,7 +10,7 @@ tmdb:
``` ```
| Name | Attribute | Allowed Values | Default | Required | | Name | Attribute | Allowed Values | Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| API Key | `apikey` | User TMDb API Key | N/A | :heavy_check_mark: | | API Key | `apikey` | User TMDb API Key | N/A | :heavy_check_mark: |
| Language | `language` | User Language | en | :x: | | Language | `language` | User Language | en | :x: |

@ -3,7 +3,7 @@ You can build different collections using the features of [TheMovieDb.org](https
## Standard TMDb Builders ## Standard TMDb Builders
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [TMDb Collection](#tmdb-collection) | `tmdb_collection` | Gets every movie in the TMDb collection | :heavy_check_mark: | :x: | | [TMDb Collection](#tmdb-collection) | `tmdb_collection` | Gets every movie in the TMDb collection | :heavy_check_mark: | :x: |
| [TMDb List](#tmdb-list) | `tmdb_list` | Gets every movie/show in the TMDb List | :heavy_check_mark: | :heavy_check_mark: | | [TMDb List](#tmdb-list) | `tmdb_list` | Gets every movie/show in the TMDb List | :heavy_check_mark: | :heavy_check_mark: |
| [TMDb Actor](#tmdb-actor) | `tmdb_actor` | Gets every movie/show in the TMDb Person's Actor Credits | :heavy_check_mark: | :heavy_check_mark: | | [TMDb Actor](#tmdb-actor) | `tmdb_actor` | Gets every movie/show in the TMDb Person's Actor Credits | :heavy_check_mark: | :heavy_check_mark: |
@ -20,7 +20,7 @@ You can build different collections using the features of [TheMovieDb.org](https
## Standard TMDb Details Builders ## Standard TMDb Details Builders
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [TMDb Collection Details](#tmdb-collection) | `tmdb_collection_details` | Gets every movie in the TMDb collection and updates the collection with the summary, poster, and background from the TMDb collection | :heavy_check_mark: | :x: | | [TMDb Collection Details](#tmdb-collection) | `tmdb_collection_details` | Gets every movie in the TMDb collection and updates the collection with the summary, poster, and background from the TMDb collection | :heavy_check_mark: | :x: |
| [TMDb List Details](#tmdb-list) | `tmdb_list_details` | Gets every movie/show in the TMDb List and updates the collection with the description of the TMDb list | :heavy_check_mark: | :heavy_check_mark: | | [TMDb List Details](#tmdb-list) | `tmdb_list_details` | Gets every movie/show in the TMDb List and updates the collection with the description of the TMDb list | :heavy_check_mark: | :heavy_check_mark: |
| [TMDb Actor Details](#tmdb-actor) | `tmdb_actor_details` | Gets every movie/show in the TMDb Person's Actor Credits with the biography and profile from the TMDb person | :heavy_check_mark: | :heavy_check_mark: | | [TMDb Actor Details](#tmdb-actor) | `tmdb_actor_details` | Gets every movie/show in the TMDb Person's Actor Credits with the biography and profile from the TMDb person | :heavy_check_mark: | :heavy_check_mark: |
@ -34,7 +34,7 @@ You can build different collections using the features of [TheMovieDb.org](https
## Other TMDb Builders ## Other TMDb Builders
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [TMDb Popular](#tmdb-popular) | `tmdb_popular` | Gets the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/movie)/[Popular Shows](https://www.themoviedb.org/tv) list | :heavy_check_mark: | :heavy_check_mark: | | [TMDb Popular](#tmdb-popular) | `tmdb_popular` | Gets the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/movie)/[Popular Shows](https://www.themoviedb.org/tv) list | :heavy_check_mark: | :heavy_check_mark: |
| [TMDb Now Playing](#tmdb-now-playing) | `tmdb_now_playing` | Gets the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-playing) list | :heavy_check_mark: | :x: | | [TMDb Now Playing](#tmdb-now-playing) | `tmdb_now_playing` | Gets the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-playing) list | :heavy_check_mark: | :x: |
| [TMDb Top Rated](#tmdb-top-rated) | `tmdb_top_rated` | Gets the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[Top Rated Shows](https://www.themoviedb.org/tv/top-rated) list | :heavy_check_mark: | :heavy_check_mark: | | [TMDb Top Rated](#tmdb-top-rated) | `tmdb_top_rated` | Gets the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[Top Rated Shows](https://www.themoviedb.org/tv/top-rated) list | :heavy_check_mark: | :heavy_check_mark: |
@ -391,7 +391,7 @@ collections:
Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/discover) to get every movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or [show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/discover) to get every movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or [show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided
| Type | Description | | Type | Description |
| :-- | :-- | | :--- | :--- |
| String | Any number of alphanumeric characters | | String | Any number of alphanumeric characters |
| Integer | Any whole number greater than zero i.e. 2, 10, 50 | | Integer | Any whole number greater than zero i.e. 2, 10, 50 |
| Number | Any number greater than zero i.e. 2.5, 7.4, 9 | | Number | Any number greater than zero i.e. 2.5, 7.4, 9 |
@ -401,7 +401,7 @@ Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/disco
### Discover Movies Parameters ### Discover Movies Parameters
| Movie Parameters | Description | Type | | Movie Parameters | Description | Type |
| :-- | :-- | :--: | | :--- | :--- | :---: |
| `limit` | Specify how many movies you want returned by the query. (default: 100) | Integer | | `limit` | Specify how many movies you want returned by the query. (default: 100) | Integer |
| `language` | Specify a language to query translatable fields with. (default: en-US) | `([a-z]{2})-([A-Z]{2})` | | `language` | Specify a language to query translatable fields with. (default: en-US) | `([a-z]{2})-([A-Z]{2})` |
| `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. | `^[A-Z]{2}$` | | `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. | `^[A-Z]{2}$` |
@ -435,7 +435,7 @@ Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/disco
### Discover Shows Parameters ### Discover Shows Parameters
| Show Parameters | Description | Type | | Show Parameters | Description | Type |
| :-- | :-- | :--: | | :--- | :--- | :---: |
| `limit` | Specify how many movies you want to be returned by the query. (default: 100) | Integer | | `limit` | Specify how many movies you want to be returned by the query. (default: 100) | Integer |
| `language` | Specify a language to query translatable fields with. (default: en-US) | `([a-z]{2})-([A-Z]{2})` | | `language` | Specify a language to query translatable fields with. (default: en-US) | `([a-z]{2})-([A-Z]{2})` |
| `sort_by` | Choose from one of the many available sort options. (default: `popularity.desc`) | See [sort options](#sort-options) below | | `sort_by` | Choose from one of the many available sort options. (default: `popularity.desc`) | See [sort options](#sort-options) below |
@ -463,7 +463,7 @@ Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/disco
### Sort Options ### Sort Options
| Sort Option | Movie Sort | Show Sort | | Sort Option | Movie Sort | Show Sort |
| :-- | :--: | :--: | | :--- | :---: | :---: |
| `popularity.asc` | :heavy_check_mark: | :heavy_check_mark: | | `popularity.asc` | :heavy_check_mark: | :heavy_check_mark: |
| `popularity.desc` | :heavy_check_mark: | :heavy_check_mark: | | `popularity.desc` | :heavy_check_mark: | :heavy_check_mark: |
| `original_title.asc` | :heavy_check_mark: | :x: | | `original_title.asc` | :heavy_check_mark: | :x: |

@ -3,7 +3,7 @@ You can build different collections using the features of [TheTVDb.com](https://
No configuration is required for these builders. No configuration is required for these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [TVDb List](#tvdb-list) | `tvdb_list` | Gets every show in a [TVDb List](https://www.thetvdb.com/lists) or [TVDb Userlist](https://www.thetvdb.com/lists/custom) | :heavy_check_mark: | :heavy_check_mark: | | [TVDb List](#tvdb-list) | `tvdb_list` | Gets every show in a [TVDb List](https://www.thetvdb.com/lists) or [TVDb Userlist](https://www.thetvdb.com/lists/custom) | :heavy_check_mark: | :heavy_check_mark: |
| [TVDb List Details](#tvdb-list) | `tvdb_list_details` | Gets every show in a [TVDb List](https://www.thetvdb.com/lists) or [TVDb Userlist](https://www.thetvdb.com/lists/custom) and updates the collection summary with the TVDb list description | :heavy_check_mark: | :heavy_check_mark: | | [TVDb List Details](#tvdb-list) | `tvdb_list_details` | Gets every show in a [TVDb List](https://www.thetvdb.com/lists) or [TVDb Userlist](https://www.thetvdb.com/lists/custom) and updates the collection summary with the TVDb list description | :heavy_check_mark: | :heavy_check_mark: |
| [TVDb Show](#tvdb-show) | `tvdb_show` | Gets the series specified | :x: | :heavy_check_mark: | | [TVDb Show](#tvdb-show) | `tvdb_show` | Gets the series specified | :x: | :heavy_check_mark: |

@ -10,7 +10,7 @@ tautulli:
``` ```
| Name | Attribute | Allowed Values | Default | Required | | Name | Attribute | Allowed Values | Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| Tautulli URL | `url` | Tautulli URL<br><strong>Example:</strong> http://192.168.1.12:8659 | N/A | :heavy_check_mark: | | Tautulli URL | `url` | Tautulli URL<br><strong>Example:</strong> http://192.168.1.12:8659 | N/A | :heavy_check_mark: |
| API Key | `apikey` | Tautulli API Key | N/A | :heavy_check_mark: | | API Key | `apikey` | Tautulli API Key | N/A | :heavy_check_mark: |

@ -5,7 +5,7 @@ You can build different collections using the features of [Tautulli](https://tau
It has watch analytics that can show the most watched or most popular Movies/Shows in each Library. It has watch analytics that can show the most watched or most popular Movies/Shows in each Library.
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [Tautulli Popular](#tautulli-popularwatched) | `tautulli_popular` | Gets the Tautulli Most Popular List | :heavy_check_mark: | :heavy_check_mark: | | [Tautulli Popular](#tautulli-popularwatched) | `tautulli_popular` | Gets the Tautulli Most Popular List | :heavy_check_mark: | :heavy_check_mark: |
| [Tautulli Watched](#tautulli-popularwatched) | `tautulli_watched` | Gets the Tautulli Most Watched List | :heavy_check_mark: | :heavy_check_mark: | | [Tautulli Watched](#tautulli-popularwatched) | `tautulli_watched` | Gets the Tautulli Most Watched List | :heavy_check_mark: | :heavy_check_mark: |
@ -13,7 +13,7 @@ It has watch analytics that can show the most watched or most popular Movies/Sho
Both Tautulli Popular and Tautulli Watched have the same sub-attributes detailed below. Both Tautulli Popular and Tautulli Watched have the same sub-attributes detailed below.
| Attribute | Description | Required | Default | | Attribute | Description | Required | Default |
| :-- | :-- | :--: | :--: | | :--- | :--- | :---: | :---: |
| `list_days` | Number of Days to look back of the list | :x: | 30 | | `list_days` | Number of Days to look back of the list | :x: | 30 |
| `list_size` | Number of Movies/Shows to add to this list | :x: | 10 | | `list_size` | Number of Movies/Shows to add to this list | :x: | 10 |
| `list_buffer` | Number of extra Movies/Shows to grab in case you have multiple show/movie Libraries. | :x: | 10 | | `list_buffer` | Number of extra Movies/Shows to grab in case you have multiple show/movie Libraries. | :x: | 10 |

@ -17,7 +17,7 @@ trakt:
``` ```
| Name | Attribute | Allowed Values | Default | Required | | Name | Attribute | Allowed Values | Default | Required |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| Client ID | `client_id` | Trakt Application Client ID | N/A | :heavy_check_mark: | | Client ID | `client_id` | Trakt Application Client ID | N/A | :heavy_check_mark: |
| Client Secret | `client_secret` | Trakt Application Client Secret | N/A | :heavy_check_mark: | | Client Secret | `client_secret` | Trakt Application Client Secret | N/A | :heavy_check_mark: |

@ -3,7 +3,7 @@ You can build different collections using the features of [Trakt.tv](https://tra
[Configuring Trakt](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Trakt-Attributes) in the config is required for any of these builders. [Configuring Trakt](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Trakt-Attributes) in the config is required for any of these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows | | Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: | | :--- | :--- | :--- | :---: | :---: |
| [Trakt List](#trakt-list) | `trakt_list` | Gets every movie/show in the Trakt List | :heavy_check_mark: | :heavy_check_mark: | | [Trakt List](#trakt-list) | `trakt_list` | Gets every movie/show in the Trakt List | :heavy_check_mark: | :heavy_check_mark: |
| [Trakt List Details](#trakt-list) | `trakt_list_details` | Gets every movie/show in the Trakt List and updates the collection summary with the list description | :heavy_check_mark: | :heavy_check_mark: | | [Trakt List Details](#trakt-list) | `trakt_list_details` | Gets every movie/show in the Trakt List and updates the collection summary with the list description | :heavy_check_mark: | :heavy_check_mark: |
| [Trakt Watchlist](#trakt-watchlist) | `trakt_watchlist` | Gets every movie/show in a Users Watchlist | :heavy_check_mark: | :heavy_check_mark: | | [Trakt Watchlist](#trakt-watchlist) | `trakt_watchlist` | Gets every movie/show in a Users Watchlist | :heavy_check_mark: | :heavy_check_mark: |

Loading…
Cancel
Save