Wiki 1.13.1 update

master
meisnate12 3 years ago
parent 6efe00cb1e
commit 633a6ed4ac

@ -11,6 +11,9 @@ There are multiple different sources you can build collections from listed below
* [Trakt Builders](Trakt-Builders)
* [Tautulli Builders](Tautulli-Builders)
* [Letterboxd Builders](Letterboxd-Builders)
* [ICheckMovies Builders](ICheckMovies-Builders)
* [FlixPatrol Builders](FlixPatrol-Builders)
* [StevenLu Builders](StevenLu-Builders)
* [AniDB Builders](AniDB-Builders)
* [AniList Builders](AniList-Builders)
* [MyAnimeList Builders](MyAnimeList-Builders)

@ -148,6 +148,9 @@ All the following attributes update various details of the metadata for every it
| Label | `item_label` | Used to append new labels to every movie/show in the collection | Comma-separated string of labels to append | :heavy_check_mark: | :heavy_check_mark: |
| Label Remove | `item_label.remove` | Used to remove existing labels from every movie/show in the collection | Comma-separated string of labels to remove | :heavy_check_mark: | :heavy_check_mark: |
| Label Sync | `item_label.sync` | Matches the labels of every movie/show in the collection to the labels provided | Comma-separated string of labels to sync | :heavy_check_mark: | :heavy_check_mark: |
| Lock Posters | `item_lock_poster` | Locks the poster of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
| Lock Backgrounds | `item_lock_background` | Locks the background of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
| Lock Titles | `item_lock_title` | Locks the title of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
| Image Overlay | `item_overlay` | Adds and overlay image to the poster of every movie/show in the collection | [`item_overlay` details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Overlay-Attribute) | :heavy_check_mark: | :heavy_check_mark: |
| Check For Assets | `item_assets` | Checks your assets folders for assets of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
| Refresh Item | `item_refresh` | Refreshes the metadata of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |

@ -10,14 +10,16 @@ The YAML mappings that can be set in the configuration file's root:
| :--- | :--- | :---: |
| [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: |
| [Webhooks](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Webhooks-Attributes) | `webhooks` | :x: |
| [Plex](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Attributes) | `plex` | :x: |
| [TMDb](https://github.com/meisnate12/Plex-Meta-Manager/wiki/TMDb-Attributes) | `tmdb` | :heavy_check_mark: |
| [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) | `radarr` | :x: |
| [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) | `sonarr` | :x: |
| [Tautulli](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Tautulli-Attributes) | `tautulli` | :x: |
| [OMDb](https://github.com/meisnate12/Plex-Meta-Manager/wiki/OMDb-Attributes) | `omdb` | :x: |
| [Notifiarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Notifiarr-Attributes) | `notifiarr` | :x: |
| [AniDB](https://github.com/meisnate12/Plex-Meta-Manager/wiki/AniDB-Attributes) | `anidb` | :x: |
| [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) | `radarr` | :x: |
| [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) | `sonarr` | :x: |
| [Trakt](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Trakt-Attributes) | `trakt` | :x: |
| [MyAnimeList](https://github.com/meisnate12/Plex-Meta-Manager/wiki/MyAnimeList-Attributes) | `mal` | :x: |
| [Webhooks](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Webhooks-Attributes) | `webhooks` | :x: |
* You can find a template config file in [config/config.yml.template](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/config/config.yml.template)

@ -0,0 +1,87 @@
You can build different collections using the features of [FlixPatrol.com](https://flixpatrol.com/) (FlixPatrol).
No configuration is required for this builder.
| Name | Attribute | Description | Works with Movies | Works with Shows |
| :--- | :--- | :--- | :---: | :---: |
| [FlixPatrol Top](#flixpatrol-top-platform) | `flixpatrol_top` | Gets every movie/show from [FlixPatrol's Top Platform Lists](https://flixpatrol.com/top10/) based on the attributes provided. | :heavy_check_mark: | :heavy_check_mark: |
| [FlixPatrol Popular](#flixpatrol-popular) | `flixpatrol_popular` | Gets every movie/show from FlixPatrol's Popular [Movies](https://flixpatrol.com/popular/movies/)/[Shows](https://flixpatrol.com/popular/tv-shows/) Lists based on the attributes provided. | :heavy_check_mark: | :heavy_check_mark: |
| [FlixPatrol Demographics](#flixpatrol-demographics) | `flixpatrol_demographics` | Gets every movie/show from [FlixPatrol's Demographics Lists](https://flixpatrol.com/demographics/) based on the attributes provided. | :heavy_check_mark: | :heavy_check_mark: |
| [FlixPatrol URL](#flixpatrol-url) | `flixpatrol_url` | Gets every movie/show found at a FlixPatrol URL. | :heavy_check_mark: | :heavy_check_mark: |
## FlixPatrol Top Platform
Gets every movie/show from [FlixPatrol's Top Platform Lists](https://flixpatrol.com/top10/) based on the attributes provided.
### Top Platform Attribute
| Attribute | Description | Options | Required | Default |
| :--- | :--- | :---: | :---: | :---: |
| `platform` | Streaming Platform to filter on. | `netflix`, `hbo`, `disney`, `amazon`, `itunes`, `google`, `paramount_plus`, `hulu`, `vudu`, `imdb`, `amazon_prime`, `star_plus` | :heavy_check_mark: | :x: |
| `location` | Location to filter on. | `world`, `albania`, `argentina`, `armenia`, `australia`, `austria`, `azerbaijan`, `bahamas`, `bahrain`, `bangladesh`, `belarus`, `belgium`, `belize`, `benin`, `bolivia`, `bosnia_and_herzegovina`, `botswana`, `brazil`, `bulgaria`, `burkina_faso`, `cambodia`, `canada`, `chile`, `colombia`, `costa_rica`, `croatia`, `cyprus`, `czech_republic`, `denmark`, `dominican_republic`, `ecuador`, `egypt`, `estonia`, `finland`, `france`, `gabon`, `germany`, `ghana`, `greece`, `guatemala`, `guinea_bissau`, `haiti`, `honduras`, `hong_kong`, `hungary`, `iceland`, `india`, `indonesia`, `ireland`, `israel`, `italy`, `ivory_coast`, `jamaica`, `japan`, `jordan`, `kazakhstan`, `kenya`, `kuwait`, `kyrgyzstan`, `laos`, `latvia`, `lebanon`, `lithuania`, `luxembourg`, `malaysia`, `maldives`, `mali`, `malta`, `mexico`, `moldova`, `mongolia`, `montenegro`, `morocco`, `mozambique`, `namibia`, `netherlands`, `new_zealand`, `nicaragua`, `niger`, `nigeria`, `north_macedonia`, `norway`, `oman`, `pakistan`, `panama`, `papua_new_guinea`, `paraguay`, `peru`, `philippines`, `poland`, `portugal`, `qatar`, `romania`, `russia`, `rwanda`, `salvador`, `saudi_arabia`, `senegal`, `serbia`, `singapore`, `slovakia`, `slovenia`, `south_africa`, `south_korea`, `spain`, `sri_lanka`, `sweden`, `switzerland`, `taiwan`, `tajikistan`, `tanzania`, `thailand`, `togo`, `trinidad_and_tobago`, `turkey`, `turkmenistan`, `uganda`, `ukraine`, `united_arab_emirates`, `united_kingdom`, `united_states`, `uruguay`, `uzbekistan`, `venezuela`, `vietnam`, `zambia`, `zimbabwe` | :x: | `world` |
| `time_window` | Time window to filter on. | `today`, `yesterday`,`this_week`, `last_week`, `this_month`, `last_month`, `this_year`, `last_year` | :x: | `today` |
| `limit` | Number of items to return. | Integer greater then 0 | :x: | 10 |
```yaml
collections:
US Netflix Monthly Top 20:
flicpatrol_top:
platform: netflix
location: united_states
time_window: this_month
limit: 20
```
## FlixPatrol Popular
Gets every movie/show from FlixPatrol's Popular [Movies](https://flixpatrol.com/popular/movies/)/[Shows](https://flixpatrol.com/popular/tv-shows/) Lists based on the attributes provided.
### Popular Attribute
| Attribute | Description | Options | Required | Default |
| :--- | :--- | :---: | :---: | :---: |
| `source` | Source to filter on. | `movie_db`, `facebook`, `google`, `twitter`, `twitter_trends`, `instagram`, `instagram_trends`, `youtube`, `imdb`, `letterboxd`, `rotten_tomatoes`, `tmdb`, `trakt` | :x: | `movie_db` |
| `time_window` | Time window to filter on. | `today`, `yesterday`,`this_week`, `last_week`, `this_month`, `last_month`, `this_year`, `last_year` | :x: | `today` |
| `limit` | Number of items to return. | Integer greater then 0 | :x: | 10 |
```yaml
collections:
Instagram Popular:
flicpatrol_popular:
source: instagram
time_window: all
limit: 20
```
## FlixPatrol Demographics
Gets every movie/show from [FlixPatrol's Demographics Lists](https://flixpatrol.com/demographics/) based on the attributes provided.
### Demographics Attribute
| Attribute | Description | Options | Required | Default |
| :--- | :--- | :---: | :---: | :---: |
| `generation` | Generation to filter on. | `all`, `boomers`, `x`, `y`, `z` | :x: | `all` |
| `gender` | Gender to filter on. | `all`, `men`, `women` | :x: | `all` |
| `location` | Location to filter on. | `world`, `brazil`, `canada`, `france`, `germany`, `india`, `mexico`, `united_kingdom`, `united_states` | :x: | `world` |
| `limit` | Number of items to return. | Integer greater then 0 | :x: | 10 |
```yaml
collections:
Gen X Male US Demographic:
flicpatrol_demographics:
generation: x
gender: men
location: united_states
limit: 20
```
## FlixPatrol URL
Gets every movie/show found at a FlixPatrol URL.
```yaml
collections:
US Netflix Monthly:
flixpatrol_url: https://flixpatrol.com/top10/netflix/united-states/2021-11/full/
Instagram Monthly Popular:
flicpatrol_url: https://flixpatrol.com/popular/movies/instagram/all-time/
Gen X Male US Demographic:
flicpatrol_url: https://flixpatrol.com/demographics/generation-x/men/united-states/
```

@ -18,6 +18,12 @@ This wiki should tell you everything you need to know about the script to get it
3. After that you can start updating Metadata and building automatic Collections by creating a [Metadata File](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Metadata-File) for each Library you want to interact with.
4. Explore the [Wiki](https://github.com/meisnate12/Plex-Meta-Manager/wiki) to see all the different Collection Builders that can be used to create collections.
## IBRACORP Video Walkthrough
[IBRACORP](https://ibracorp.io/) made a video walkthough for installing Plex Meta Manager on Unraid. While you might not be using Unraid the video goes over many key accepts of Plex Meta Manager and can be a great place to start learning how to use the script.
[![Plex Meta Manager](https://img.youtube.com/vi/dF69MNoot3w/0.jpg)](https://www.youtube.com/watch?v=dF69MNoot3w "Plex Meta Manager")
## Support
* Before posting on Github about an enhancement, error, or configuration question please visit the [Plex Meta Manager Discord Server](https://discord.gg/TsdpsFYqqm).
@ -66,6 +72,7 @@ This wiki should tell you everything you need to know about the script to get it
- [Tautulli Builders](Tautulli-Builders)
- [Letterboxd Builders](Letterboxd-Builders)
- [ICheckMovies Builders](ICheckMovies-Builders)
- [FlixPatrol Builders](FlixPatrol-Builders)
- [StevenLu Builders](StevenLu-Builders)
- [AniDB Builders](AniDB-Builders)
- [AniList Builders](AniList-Builders)

@ -1,4 +1,4 @@
Testing has been done only on Python 3.7 and 3.8 on Linux and Windows. Dependencies must be installed by running:
Testing has been done only on Python 3.6, 3.7, 3.8, and 3.9 on Linux and Windows. Dependencies must be installed by running:
```shell
pip install -r requirements.txt

@ -27,3 +27,6 @@ The available operations attributes for each library are as follows
| Split Duplicates | `split_duplicates` | Splits all duplicate movies/shows found in this library | `true` or `false` |
| Radarr Add All | `radarr_add_all` | Adds every item in the library to Radarr | `true` or `false` |
| Sonarr Add All | `sonarr_add_all` | Adds every item in the library to Sonarr | `true` or `false` |
* When using `radarr_add_all` or `sonarr_add_all` the existing paths in plex will be used as the root folder of each item.
* If the paths in Plex are not the same as your Radarr/Sonarr paths you can use the `plex_path` and `radarr_path`/`sonarr_path` [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes)/[Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) details to convert the paths

@ -14,6 +14,8 @@ radarr:
quality_profile: HD-1080p
tag: pmm
search: false
radarr_path: /media
plex_path: /share/CACHEDEV1_DATA/Multimedia
```
| Name | Attribute | Allowed Values| Default | Required |
@ -28,6 +30,8 @@ radarr:
| Quality Profile | `quality_profile` | Quality Profile To Use | N/A | :x: |
| Tag | `tag` | Add this list or comma-separated string of tags to every movie added to Radarr | ` ` | :x: |
| Search | `search` | Search when adding missing movies to Radarr<br>**boolean:** true or false | false | :x: |
| Plex Path | `plex_path` | When using `add_existing` or `radarr_add_all` Convert this part of the path to `radarr_path` | ` ` | :x: |
| Radarr Path | `radarr_path` | When using `add_existing` or `radarr_add_all` Convert the `plex_path` part of the path to this | ` ` | :x: |
* The `token` can be found by going to `Radarr > Settings > General > Security > API Key`

@ -40,7 +40,7 @@ settings:
| [Show Missing](#show-missing) | `show_missing` | **boolean:** true or false<br>**default: true** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [Show Missing Assets](#show-missing-assets) | `show_missing_assets` | **boolean:** true or false<br>**default: true** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [Save Missing](#save-missing) | `save_missing` | **boolean:** true or false<br>**default: true** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [TVDb Language](#tvdb-language) | `tvdb_language` | [ISO 639-2 Language Code](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) or Blank for original Language<br>**default: ** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [TVDb Language](#tvdb-language) | `tvdb_language` | [ISO 639-2 Language Code](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) or Blank for original Language<br>**default:** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
## Cache

@ -17,6 +17,8 @@ sonarr:
tag: pmm
search: false
cutoff_search: false
sonarr_path: /media
plex_path: /share/CACHEDEV1_DATA/Multimedia
```
| Name | Attribute | Allowed Values| Default | Required |
@ -34,6 +36,8 @@ sonarr:
| Tag | `tag` | Add this list or comma-separated string of tags to every show added to Sonarr | ` ` | :x: |
| Search | `search` | Start search for missing episodes<br>**boolean:** true or false | false | :x: |
| Cutoff Search | `cutoff_search` | Start search for cutoff unmet episodes<br>**boolean:** true or false | false | :x: |
| Plex Path | `plex_path` | When using `add_existing` or `sonarr_add_all` Convert this part of the path to `sonarr_path` | ` ` | :x: |
| Sonarr Path | `sonarr_path` | When using `add_existing` or `sonarr_add_all` Convert the `plex_path` part of the path to this | ` ` | :x: |
* The `token` can be found by going to `Sonarr > Settings > General > Security > API Key`

@ -411,11 +411,13 @@ Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/disco
| `certification.lte` | Filter and only include movies that have a certification that is less than or equal to the specified value. | String |
| `certification.gte` | Filter and only include movies that have a certification that is greater than or equal to the specified value. | String |
| `include_adult` | A filter and include or exclude adult movies. | Boolean |
| `include_video` | A filter and include or exclude videos. | Boolean |
| `primary_release_year` | A filter to limit the results to a specific primary release year. | Year: YYYY |
| `primary_release_date.gte` | Filter and only include movies that have a primary release date that is greater or equal to the specified value. | Date: `MM/DD/YYYY` |
| `primary_release_date.lte` | Filter and only include movies that have a primary release date that is less than or equal to the specified value. | Date: `MM/DD/YYYY` |
| `release_date.gte` | Filter and only include movies that have a release date (looking at all release dates) that is greater or equal to the specified value. | Date: `MM/DD/YYYY` |
| `release_date.lte` | Filter and only include movies that have a release date (looking at all release dates) that is less than or equal to the specified value. | Date: `MM/DD/YYYY` |
| `with_release_type` | Specify a comma (AND) or pipe (OR) separated value to filter release types by. (1: Premiere, 2: Theatrical (limited), 3: Theatrical, 4: Digital, 5: Physical, 6: TV) | String |
| `year` | A filter to limit the results to a specific year (looking at all release dates). | Year: YYYY |
| `vote_count.gte` | Filter and only include movies that have a vote count that is greater or equal to the specified value. | Integer |
| `vote_count.lte` | Filter and only include movies that have a vote count that is less than or equal to the specified value. | Integer |
@ -425,6 +427,7 @@ Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/disco
| `with_crew` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as a crew member. | String |
| `with_people` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as either an actor or a crew member. | String |
| `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company. | String |
| `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported. | String |
| `with_genres` | Comma-separated value of genre ids that you want to include in the results. | String |
| `without_genres` | Comma-separated value of genre ids that you want to exclude from the results. | String |
| `with_keywords` | A comma-separated list of keyword ID's. Only includes movies that have one of the ID's added as a keyword. | String |
@ -432,6 +435,9 @@ Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/disco
| `with_runtime.gte` | Filter and only include movies that have a runtime that is greater or equal to a value. | Integer |
| `with_runtime.lte` | Filter and only include movies that have a runtime that is less than or equal to a value. | Integer |
| `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value. | String |
| `with_watch_providers` | A comma or pipe separated list of watch provider ID's. Combine this filter with `watch_region` in order to filter your results by a specific watch provider in a specific region. | String |
| `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region. | String |
| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type. | `flatrate`, `free`, `ads`, `rent`, `buy` |
### Discover Shows Parameters
| Show Parameters | Description | Type |
@ -452,6 +458,7 @@ Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/disco
| `vote_average.lte` | Filter and only include TV that have a rating that is less than or equal to the specified value. | Number |
| `with_networks` | Comma-separated value of network ids that you want to include in the results. | String |
| `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company. | String |
| `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported. | String |
| `with_genres` | Comma-separated value of genre ids that you want to include in the results. | String |
| `without_genres` | Comma-separated value of genre ids that you want to exclude from the results. | String |
| `with_keywords` | A comma-separated list of keyword ID's. Only includes TV shows that have one of the ID's added as a keyword. | String |
@ -460,6 +467,11 @@ Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/disco
| `with_runtime.lte` | Filter and only include TV shows with an episode runtime that is less than or equal to a value. | Integer |
| `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value. | String |
| `screened_theatrically` | Filter results to include items that have been screened theatrically. | Boolean |
| `with_watch_providers` | A comma or pipe separated list of watch provider ID's. Combine this filter with `watch_region` in order to filter your results by a specific watch provider in a specific region. | String |
| `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region. | String |
| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type. | `flatrate`, `free`, `ads`, `rent`, `buy` |
| `with_status` | Filter TV shows by their status. | `0`: Returning Series, `1`: Planned, `2`: In Production, `3`: Ended, `4`: Cancelled, `5`: Pilot) |
| `with_type` | Filter TV shows by their type. | `0`: Documentary, `1`: News, `2`: Miniseries, `3`: Reality, `4`: Scripted, `5`: Show, `6`: Video) |
### Sort Options
| Sort Option | Movie Sort | Show Sort |

@ -15,6 +15,7 @@ Both Tautulli Popular and Tautulli Watched have the same sub-attributes detailed
| Attribute | Description | Required | Default |
| :--- | :--- | :---: | :---: |
| `list_days` | Number of Days to look back of the list | :x: | 30 |
| `list_minimum` | Minimum Number of Users Watching/Plays to add to the list | :x: | 30 |
| `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 |

@ -36,6 +36,7 @@
- [Tautulli Builders](Tautulli-Builders)
- [Letterboxd Builders](Letterboxd-Builders)
- [ICheckMovies Builders](ICheckMovies-Builders)
- [FlixPatrol Builders](FlixPatrol-Builders)
- [StevenLu Builders](StevenLu-Builders)
- [AniDB Builders](AniDB-Builders)
- [AniList Builders](AniList-Builders)

Loading…
Cancel
Save