Difference between revisions of "Add-on:The Movie Database Python"

From Official Kodi Wiki
Jump to navigation Jump to search
m (Addon-Bot Update)
(General updates)
Line 17: Line 17:
|broken=
|broken=
|icon url=http://mirrors.kodi.tv/addons/matrix/metadata.themoviedb.org.python/resources/icon.png}}
|icon url=http://mirrors.kodi.tv/addons/matrix/metadata.themoviedb.org.python/resources/icon.png}}




Line 31: Line 32:


= Search =
= Search =
If the scraper is unable to find the correct movie, you can perform a search using either the IMDB or TMDB ID's. This may be a more convenient method than using a [[NFO_files#Parsing_nfo|Parsing NFO file]].
If the scraper is unable to find the correct movie, you can perform a search using either the IMDB or TMDB ID's. This may be a more convenient method than using a '''[[NFO_files#Parsing_nfo|Parsing NFO file]]'''.
* To search by TMDB enter the prefix '''tmdb/''' followed by the ID. eg '''tmdb/240832'''.  
* To search by TMDB enter the prefix '''tmdb/''' followed by the ID. eg '''tmdb/240832'''.  
* To search by IMDB ID enter the ttxxxxxx ID directly without any prefix
* To search by IMDB ID enter the ttxxxxxx ID directly without any prefix
Line 37: Line 38:
<gallery mode="packed" widths="500px" heights="293px">
<gallery mode="packed" widths="500px" heights="293px">
File:The-Movie-Database-Python-04.jpg|Image 1- If the correct movie is not in the list, select '''Manual'''
File:The-Movie-Database-Python-04.jpg|Image 1- If the correct movie is not in the list, select '''Manual'''
File:The-Movie-Database-Python-05.jpg|Image 2- If using the '''IMDB ID''', enter it as shown
File:The-Movie-Database-Python-05.jpg|Image 2- If using the '''IMDB ID''', enter it as shown then select OK
File:The-Movie-Database-Python-06.jpg|Image 3- If using the '''TMDB ID''', enter it as shown using the '''tmdb/''' prefix
File:The-Movie-Database-Python-06.jpg|Image 3- If using the '''TMDB ID''', enter it as shown using the '''tmdb/''' prefix then select OK
File:The-Movie-Database-Python-07.jpg|Image 4- Select the correct movie from the list.
File:The-Movie-Database-Python-07.jpg|Image 4- Select the correct movie from the list.
</gallery>
</gallery>
Line 47: Line 48:
Scraper settings can be adjusted in two locations, each location having a different result. When adjusting the settings be mindful of where:
Scraper settings can be adjusted in two locations, each location having a different result. When adjusting the settings be mindful of where:


;Settings>Add-ons
;Settings>Add-ons>Information Providers>Movies
:Scrapers are installed with default settings. Adjusting settings in this location sets the new '''default''' settings for your scraper. From this point on any source where you change to this scraper will use the new default settings. '''Existing sources are not changed'''
:Scrapers are installed with default settings. Adjusting settings in this location sets the new '''default''' settings for your scraper. From this point on any source you change to use this scraper will use the new default settings. '''Existing sources are not changed'''
:If an existing source is already using this scraper, and you would like the new settings to take effect, change the source to use another scraper, save and answer no to updating the library. Then change the scraper back and the new default settings will be loaded.
:If an existing source is already using this scraper, and you would like the new settings to take effect, change the source to use another scraper, save and answer no to updating the library. Then change the scraper back and the new default settings will be loaded for the source. Alternatively, use the next method.


;Videos>Files>Source
;Videos>Files>Source>Context Menu>Change Source>Settings
:Changing settings at the source will affect that source only.
:Changing settings at the source will affect that source only.




'''Note:''' Changing scraper settings '''does not''' change what is already in your library. Only items scraped after the setting changes will be affected.
'''Note:''' Changing scraper settings '''does not''' change the metadata or artwork already in your library. Only items scraped after the setting changes will be affected.




Line 64: Line 65:


; Keep Original Title
; Keep Original Title
: Use the original (untranslated) title when downloading info for a foreign film.
: Use the original (untranslated) title when downloading metadata for a foreign film.
: For example the movie ''[https://www.themoviedb.org/movie/146-wo-hu-cang-long Crouching Tiger, Hidden Dragon (2000)]'' is the English translated title of the movie. The Original Name of the movie is '''{{big|卧虎藏龙}}'''. If you prefer the English translated title (or whichever language you have set in the scraper settings), then '''disable''' the setting. If you prefer the original Chinese title then '''enable''' the setting.
: For example the movie ''[https://www.themoviedb.org/movie/146-wo-hu-cang-long Crouching Tiger, Hidden Dragon (2000)]'' is the English translated title of the movie. The Original Name of the movie is '''{{big|卧虎藏龙}}'''. If you prefer the English translated title (or whichever language you have set in the scraper settings), then '''disable''' the setting. If you prefer the original title then '''enable''' the setting.


; Enable fanart from TMDb
; Enable fanart from TMDb
: Enable this setting to download [[Artwork|Fanart]] from TMDB. Will override the fanart.tv setting.
: The scraper uses fanart.tv as first choice for fanart. Enable this setting to download [[Artwork|Fanart]] from TMDB instead. Will override the fanart.tv setting.


; Separate TMDb fanart with title to landscape
; Separate TMDb fanart with title to landscape
: Fanart is 16:9 artwork with no text. Landscape is fanart with text.
: Fanart is 16:9 artwork with no text. Landscape is fanart with text.
: With this setting enabled, fanart with text is scraped as a Landscape image type.  
: With this setting enabled, 16:9 images with text are scraped as a Landscape image type.


; Enable Trailer (YouTube)
; Enable Trailer (YouTube)
: Scrapes the links for trailers from YouTube.
: Scrapes the links for trailers from YouTube.
: {{warning|If you have locally saved trailers, do not enable this setting. See... [[Trailers]]}}
: If you have locally saved trailers, do not enable this setting. See... '''[[Trailers]]'''
 
; Preferred Language
; Preferred Language
: Set which language metadata to scrape
: Set which language metadata to scrape


; Preferred Certification Country
; Preferred Certification Country
: Country/Nation preference for Content Advisory Ratings (MPAA)- eg M, MA, PG
: Country preference for Content Advisory Ratings (MPAA)- eg M, MA, PG
 
; Search Language
: If your movie folders and files use a language other than English then, to reduce false matches, use this setting to limit the search to the selected language which would match the language you have used to name your movie folders and files.


; Certification Prefix
; Certification Prefix
Line 87: Line 92:


; Default Rating from
; Default Rating from
: Choose which default rating to download. Choices are TMDB, IMDB and Trakt.
: Choose which rating to download and display as the default rating. Most skins displays only a single rating. Choices are TMDB, IMDB and Trakt.


; Add also IMDB ratings
; Add also IMDB ratings
: Add IMDB in addition to the default rating
: Download IMDB ratings in addition to the default rating. If IMDB is selected as default above, this setting will not be visible.


; Add also Trakt.tv ratings
; Add also Trakt.tv ratings
: Add Trakt.tv in addition to the default rating
: Download Trakt.tv ratings in addition to the default rating. If Trakt.tv is selected as default above, this setting will not be visible.


; Add multiple studios
; Add multiple studios
Line 104: Line 109:


== Fanart.tv ==
== Fanart.tv ==
This section allows you to nominate which extra artwork you would like scraped.
This section controls artwork scraping from '''[https://fanart.tv/ fanart.tv]'''


Due to changes in Artwork handling within the core program, v18 and v19 use different settings as described below.
All artwork related settings are now set in {{highlight|Settings > Media > Videos}} in the new '''Artwork''' section of the {{Kodi}} settings. Use these settings to modify which artwork types are downloaded. The default is to download all artwork types.


If you had the artwork tags in your advancedsettings.xml file from v18, these will have been transferred across to the new settings system and added to the ''Custom'' setting, otherwise you will need to manually enter which artwork types you prefer.


=== v18 - Leia ===
[[File:Movie-Database-Python-08.jpg|700px|Image 9- Fanart.tv]]
----
The following are the available settings for extra artwork from fanart.tv.


Settings are for Movies and the Movie Set if the movie is part of a Collection.


<gallery mode="packed" widths="700px" heights="394px">
; Enable artwork from fanart.tv
File:Movie-Database-Python-02.jpg|Image 6- Fanart.tv settings page 1
: This setting is enabled by default which allows scraping of artwork from fanart.tv.  
File:Movie-Database-Python-03.jpg|Image 7- Fanart.tv settings page 2
: For those that prefer no extended artwork, disable this setting. Artwork will then be limited to ''Poster, fanart, landscape'' and ''clearlogo'' as provided by TheMovieDB, unless you have further adjusted the artwork settings in {{Kodi}}.
</gallery>


 
; Prioritize fanart.tv artworks over preferred language
=== v19 - Matrix ===
: If an artwork type is not available in your chosen language, then:
----
:: Enabling this setting downloads the artwork in the first available language.
{{Future|19}}
:: Disabling this setting will not download any artwork for that particular artwork type.
 
Scraping and caching of extended artwork is now a single step process. The artwork settings have been removed from the scraper, as well as the requirement for editing the advancedsettings.xml file.
 
{{warning|All artwork related settings are now set in {{highlight|Settings > Media > Videos}} in the new '''Artwork''' section of the {{Kodi}} settings.<br>If you had the artwork tags in your advancedsettings.xml file from v18, these will have been transferred across to the new settings system and added to the ''Custom'' setting, otherwise you will need to manually enter which artwork types you prefer.}}
 
[[File:Movie-Database-Python-08.jpg|700px|Image 9- Fanart.tv]]
 
; Enable artwork from fanart.tv
: This setting is enabled by default which allows scraping of artwork.
: For those that prefer no extended artwork, a single toggle is available to disable artwork scraping from fanart.tv.  


; Language for Fanart.tv artwork
; Language for Fanart.tv artwork
: Allows you to select a language different to the metadata language. The default setting is English.
: Allows you to select the language of the artwork for ''poster, clearart, clearlogo, landscape'' and other types of artwork that contain text. The default setting is English.


; Fanart.tv personal API key(optional)
; Fanart.tv personal API key(optional)
: Enter your personal API key here if you have one.
: Enter your personal API key here if you have one.
: A personal API key is not required to use these features.
: A personal API key is not required to use these features.
: For more information on API keys, see '''[https://fanart.tv/personal-api-keys/ fanart.tv Personal API Key benefits]'''





Revision as of 00:34, 23 May 2022

The Movie Database Python

See this add-on on the kodi.tv showcase

Author: Team Kodi
Website: link
Type: Movie information
Repo: Kodi.tv repo v20
Kodi.tv repo v19
Kodi.tv repo v18

License: GPL-2.0-or-later
Source: Source code
Summary: Python TMDB Movie Scraper
Home icon grey.png   ▶ Add-ons ▶ The Movie Database Python
Attention talk.png Need help with this add-on? See here.

themoviedb.org is a free and open movie database. It's completely user driven by people like you. TMDb is currently used by millions of people every month and with their powerful API, it is also used by many popular media centers like Kodi to retrieve Movie Metadata, Posters and Fanart to enrich the user's experience.

1 Installing

This add-on is installed from the Add-on browser located in Kodi as follows:

  1. Settings
  2. Add-ons
  3. Install from repository
  4. Information providers (v16 and higher)
  5. Movie information
  6. The Movie Database Python
  7. Install


2 Introduction

The Movie Database Python is the latest scraper developed by Team Kodi. It is written in Python and has proven to be more stable and reliable than the Regex based scrapers currently in use.

The Movie Database Python scraper accesses the following sites to scrape your movies and populate your library:


3 Search

If the scraper is unable to find the correct movie, you can perform a search using either the IMDB or TMDB ID's. This may be a more convenient method than using a Parsing NFO file.

  • To search by TMDB enter the prefix tmdb/ followed by the ID. eg tmdb/240832.
  • To search by IMDB ID enter the ttxxxxxx ID directly without any prefix


4 Settings

Scraper settings can be adjusted in two locations, each location having a different result. When adjusting the settings be mindful of where:

Settings>Add-ons>Information Providers>Movies
Scrapers are installed with default settings. Adjusting settings in this location sets the new default settings for your scraper. From this point on any source you change to use this scraper will use the new default settings. Existing sources are not changed
If an existing source is already using this scraper, and you would like the new settings to take effect, change the source to use another scraper, save and answer no to updating the library. Then change the scraper back and the new default settings will be loaded for the source. Alternatively, use the next method.
Videos>Files>Source>Context Menu>Change Source>Settings
Changing settings at the source will affect that source only.


Note: Changing scraper settings does not change the metadata or artwork already in your library. Only items scraped after the setting changes will be affected.


4.1 General

Image 5- General Settings

Keep Original Title
Use the original (untranslated) title when downloading metadata for a foreign film.
For example the movie Crouching Tiger, Hidden Dragon (2000) is the English translated title of the movie. The Original Name of the movie is 卧虎藏龙. If you prefer the English translated title (or whichever language you have set in the scraper settings), then disable the setting. If you prefer the original title then enable the setting.
Enable fanart from TMDb
The scraper uses fanart.tv as first choice for fanart. Enable this setting to download Fanart from TMDB instead. Will override the fanart.tv setting.
Separate TMDb fanart with title to landscape
Fanart is 16:9 artwork with no text. Landscape is fanart with text.
With this setting enabled, 16:9 images with text are scraped as a Landscape image type.
Enable Trailer (YouTube)
Scrapes the links for trailers from YouTube.
If you have locally saved trailers, do not enable this setting. See... Trailers
Preferred Language
Set which language metadata to scrape
Preferred Certification Country
Country preference for Content Advisory Ratings (MPAA)- eg M, MA, PG
Search Language
If your movie folders and files use a language other than English then, to reduce false matches, use this setting to limit the search to the selected language which would match the language you have used to name your movie folders and files.
Certification Prefix
To display the appropriate Content Advisory Rating flags in your skin, the rating must be prefixed. Check with the skin author what the prefix is for your chosen country.
Default Rating from
Choose which rating to download and display as the default rating. Most skins displays only a single rating. Choices are TMDB, IMDB and Trakt.
Add also IMDB ratings
Download IMDB ratings in addition to the default rating. If IMDB is selected as default above, this setting will not be visible.
Add also Trakt.tv ratings
Download Trakt.tv ratings in addition to the default rating. If Trakt.tv is selected as default above, this setting will not be visible.
Add multiple studios
Scrape all movie studios associated with the movie.
Stop hand.png Enabling this setting will break the display of Studio Icons in your skin. Studio Icons can only be displayed for a single studio.
Add keywords as tags
Scrape Keywords from TMDB and add them as Tags in Kodi
Be aware that larger libraries may be flooded with thousands of tags in Kodi


4.2 Fanart.tv

This section controls artwork scraping from fanart.tv

All artwork related settings are now set in Settings > Media > Videos in the new Artwork section of the Kodi settings. Use these settings to modify which artwork types are downloaded. The default is to download all artwork types.

If you had the artwork tags in your advancedsettings.xml file from v18, these will have been transferred across to the new settings system and added to the Custom setting, otherwise you will need to manually enter which artwork types you prefer.

Image 9- Fanart.tv


Enable artwork from fanart.tv
This setting is enabled by default which allows scraping of artwork from fanart.tv.
For those that prefer no extended artwork, disable this setting. Artwork will then be limited to Poster, fanart, landscape and clearlogo as provided by TheMovieDB, unless you have further adjusted the artwork settings in Kodi.
Prioritize fanart.tv artworks over preferred language
If an artwork type is not available in your chosen language, then:
Enabling this setting downloads the artwork in the first available language.
Disabling this setting will not download any artwork for that particular artwork type.
Language for Fanart.tv artwork
Allows you to select the language of the artwork for poster, clearart, clearlogo, landscape and other types of artwork that contain text. The default setting is English.
Fanart.tv personal API key(optional)
Enter your personal API key here if you have one.
A personal API key is not required to use these features.
For more information on API keys, see fanart.tv Personal API Key benefits


Return to top