Python tv scraper development - Revision history

Roman V M at 22:38, 21 January 2023

2023-01-21T22:38:35Z

← Older revision		Revision as of 22:38, 21 January 2023
Line 45:		Line 45:
	* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.		* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.
	Optionally it can set unique IDs from other online TV show databases. This is needed to correctly get TV show's artwork.		Optionally it can set unique IDs from other online TV show databases. This is needed to correctly get TV show's artwork.

			* '''episodeguide''': set via <code>ListItem.setInfo()</code> instance method. This should be some unique string that can be used to retrieve the list of TV show episoded with all the necessary info.

	If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.		If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.

Roman V M at 22:33, 21 January 2023

2023-01-21T22:33:05Z

← Older revision		Revision as of 22:33, 21 January 2023
Line 45:		Line 45:
	* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.		* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.
	Optionally it can set unique IDs from other online TV show databases. This is needed to correctly get TV show's artwork.		Optionally it can set unique IDs from other online TV show databases. This is needed to correctly get TV show's artwork.

	* '''episodeguide''': set via <code>ListItem.setInfo()</code> instance method. A scraper should set '''episodeguide''' string that will allow to get the list of episodes from data provider's website or API.

	If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.		If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.

Roman V M at 22:30, 21 January 2023

2023-01-21T22:30:42Z

← Older revision		Revision as of 22:30, 21 January 2023
Line 46:		Line 46:
	Optionally it can set unique IDs from other online TV show databases. This is needed to correctly get TV show's artwork.		Optionally it can set unique IDs from other online TV show databases. This is needed to correctly get TV show's artwork.

	* '''episodeguide''': set via <code>ListItem.setInfo()</code> instance method. A scraper should set '''episodeguide''' string that will allow to get the list of episodes from data provider's		* '''episodeguide''': set via <code>ListItem.setInfo()</code> instance method. A scraper should set '''episodeguide''' string that will allow to get the list of episodes from data provider's website or API.
	website or API.

	If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.		If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.

Roman V M at 22:29, 21 January 2023

2023-01-21T22:29:51Z

← Older revision		Revision as of 22:29, 21 January 2023
Line 44:		Line 44:

	* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.		* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.
	Optionally it can set unique IDs from other online TV show databases.		Optionally it can set unique IDs from other online TV show databases. This is needed to correctly get TV show's artwork.

			* '''episodeguide''': set via <code>ListItem.setInfo()</code> instance method. A scraper should set '''episodeguide''' string that will allow to get the list of episodes from data provider's
			website or API.

	If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.		If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.

Roman V M at 15:20, 3 January 2023

2023-01-03T15:20:26Z

← Older revision		Revision as of 15:20, 3 January 2023
Line 72:		Line 72:

	The <code>getepisodelist</code> action should use <code>xbmcplugin.addDirectoryItem</code> or <code>xbmcplugin.addDirectoryItems</code> to pass <code>xbmcgui.ListItem</code> instances to Kodi		The <code>getepisodelist</code> action should use <code>xbmcplugin.addDirectoryItem</code> or <code>xbmcplugin.addDirectoryItems</code> to pass <code>xbmcgui.ListItem</code> instances to Kodi
	with information about available TV show episodes. This action receives '''url''' query parameter that is <code>episodeguide</code> property set by <code>getdetails</code> action.		with information about available TV show episodes. This action receives '''url''' query parameter that is <code>episodeguide</code> property set by <code>getdetails</code> or <code>NfoUrl</code>action.

	The <code>xbmcgui.ListItem</code> instances must be assigned the following properties:		The <code>xbmcgui.ListItem</code> instances must be assigned the following properties:
Line 97:		Line 97:
	you must set the correct default unique ID in <code>NfoUrl</code> action. Otherwise <code>getdetails</code> will receive the default unique ID from your .NFO file		you must set the correct default unique ID in <code>NfoUrl</code> action. Otherwise <code>getdetails</code> will receive the default unique ID from your .NFO file
	and your scraper may not be able to find any artwork using this ID.		and your scraper may not be able to find any artwork using this ID.

			=episodeguide=

			The <code>episodeguide</code> string is passed to <code>getepisodedetails</code> action to retrieve the list of episodes. In legacy XML scrapers it was an actual URL of a page that was supposed to contain
			the list of TV show episodes. Now in Python scrapers it can be any string that allows to correctly identify a TV show and retrieve the list of its episodes. However, the commonly accepted convention for <code>episodeguide</code> is that it should be a JSON-encoded string containing IDs of the specific TV show in various online databases. As a minimum it should include the ID of a show at the database
			the scraper works with. An example of a JSON-encoded <code>episodeguide</code> string:

			<code>{"tvmaze": "60", "tvrage": "4628", "tvdb": "72108", "imdb": "tt0364845"}</code>

			Note that all IDs should be strings.

	=Path Settings=		=Path Settings=

Roman V M at 22:17, 13 August 2022

2022-08-13T22:17:28Z

← Older revision		Revision as of 22:17, 13 August 2022
Line 73:		Line 73:
	The <code>getepisodelist</code> action should use <code>xbmcplugin.addDirectoryItem</code> or <code>xbmcplugin.addDirectoryItems</code> to pass <code>xbmcgui.ListItem</code> instances to Kodi		The <code>getepisodelist</code> action should use <code>xbmcplugin.addDirectoryItem</code> or <code>xbmcplugin.addDirectoryItems</code> to pass <code>xbmcgui.ListItem</code> instances to Kodi
	with information about available TV show episodes. This action receives '''url''' query parameter that is <code>episodeguide</code> property set by <code>getdetails</code> action.		with information about available TV show episodes. This action receives '''url''' query parameter that is <code>episodeguide</code> property set by <code>getdetails</code> action.
	~~A scraper needs to set~~ '''url''' ~~for each~~ <code>~~xbmcgui.ListItem~~</code> ~~instance that~~ is some unique string that can be used to retrieve information about a specific episode.
			The <code>xbmcgui.ListItem</code> instances must be assigned the following properties:

			* '''url''': passed as <code>url</code> parameter to the class constructor. This is some unique string that can be used to retrieve information about a specific episode.

			* '''season''': season number that is passed via <code>ListItem.setInfo</code> method.

			* '''episode''': episode number that is passed <code>ListItem.setInfo</code> method.

			* '''aired''': episode air date (if available) that is passed <code>ListItem.setInfo</code> method.

	==getepisodedetails==		==getepisodedetails==

Roman V M at 20:54, 4 August 2022

2022-08-04T20:54:26Z

← Older revision		Revision as of 20:54, 4 August 2022
Line 45:		Line 45:
	* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.		* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.
	Optionally it can set unique IDs from other online TV show databases.		Optionally it can set unique IDs from other online TV show databases.

	If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.		If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.
	In this case Kodi will use all the information parsed from the XML file and will not call '''getdetails''' action.		In this case Kodi will use all the information parsed from the XML file and will not call '''getdetails''' action.

Roman V M at 20:53, 4 August 2022

2022-08-04T20:53:33Z

← Older revision		Revision as of 20:53, 4 August 2022
Line 33:		Line 33:
	* '''thumb''' (optional): passed via <code>setArtwork()</code> of <code>xbmcgui.ListItem</code> class instance method. This should be a URL of a TV show poster, for example.		* '''thumb''' (optional): passed via <code>setArtwork()</code> of <code>xbmcgui.ListItem</code> class instance method. This should be a URL of a TV show poster, for example.

	==NfoUrl==		==NfoUrl (TV show)==

	The <code>NfoUrl</code> action is called as an alternative to <code>find</code> if <code>tvshow.nfo</code> file is present in a TV show directory.		The <code>NfoUrl</code> action is called as an alternative to <code>find</code> if <code>tvshow.nfo</code> file is present in a TV show directory.
Line 45:		Line 45:
	* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.		* '''Unique IDs''': set via <code>ListItem.setUniqueIDs()</code> instance method. A scraper should set at least the default unique ID from the TV information site it works with.
	Optionally it can set unique IDs from other online TV show databases.		Optionally it can set unique IDs from other online TV show databases.
			If <code>tvshow.nfo</code> contains all the necessary info about the respective TV show in XML format then this actions may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.
			In this case Kodi will use all the information parsed from the XML file and will not call '''getdetails''' action.

			==NfoUrl (episode)==

			The <code>NfoUrl</code> action is also called as for each episode .NFO file that is present in a TV show directory.
			The entire .NFO file contents are passed as <code>nfo</code>parameter. This action should use <code>xbmcplugin.addDirectoryItem</code> to pass a single <code>xbmcgui.ListItem</code> instance to Kodi.

			The <code>xbmcgui.ListItem</code> instances must be assigned the following properties:

			* '''url''': passed as <code>url</code> parameter to the class constructor. This should be some unique string that can be used to request all the necessary episode info from data provider's
			website or API. It can be, for example, a link to the episode page on a TV show information website or some unique ID to request episode information from a REST API.

			If an episode .NFO file contains all the necessary info about the respective episode in XML format then this action may not pass any <code>xbmcgui.ListItem</code> instance to Kodi.
			In this case Kodi will use all the information parsed from the XML file and will not call '''getepisodedetails''' action.

	==getdetails==		==getdetails==
Line 67:		Line 82:

	The <code>getartwork</code> action must pass a single <code>xbmcgui.ListItem</code> via <code>xbmcplugin.setResolvedUrl()</code> function. This action receives '''id''' query parameter		The <code>getartwork</code> action must pass a single <code>xbmcgui.ListItem</code> via <code>xbmcplugin.setResolvedUrl()</code> function. This action receives '''id''' query parameter
	that is the default unique ID set by '''NfoUrl''' or '''getdetails''' actions. This action should set available artwork using <code>ListItem.addAvailableArtwork()</code>		that is the default unique ID set by '''NfoUrl''' or '''getdetails''' actions or parsed form an XML <code>tvshow.nfo</code> file if the scraper haven't set any. This action should set available artwork using <code>ListItem.addAvailableArtwork()</code> and <code>ListItem.setAvailableFanart()</code> instance methods.
	and <code>ListItem.setAvailableFanart()</code> instance methods.

	'''Warning''': if your .NFO file contains the default unique ID that is different from the ID of the TV show database your scraper works with,		'''Warning''': if your .NFO file contains the default unique ID that is different from the ID of the TV show database your scraper works with,

Karellen: added Category:Scraper using HotCat

2022-06-20T21:13:25Z

added Category:Scraper using HotCat

← Older revision		Revision as of 21:13, 20 June 2022
Line 81:		Line 81:

	A very high-level example of a Python TV show scraper can be found in the Kodi source code as [https://github.com/xbmc/xbmc/tree/master/addons/metadata.demo.tv metadata.demo.tv addon].		A very high-level example of a Python TV show scraper can be found in the Kodi source code as [https://github.com/xbmc/xbmc/tree/master/addons/metadata.demo.tv metadata.demo.tv addon].

			[[Category:Scraper]]

Roman V M at 18:50, 19 June 2022

2022-06-19T18:50:17Z

← Older revision		Revision as of 18:50, 19 June 2022
Line 1:		Line 1:
	{{mininav\|[[Scrapers]] {{l2\|[[Development]]}} }}		{{mininav\|[[Scrapers]] {{l2\|[[Development]]}} }}

	~~{{Wiki_revamp}}~~

	=Introduction=		=Introduction=