About Add-ons - Revision history

RogueScholar: /* Other python pages */ Add link to orphaned page and remove dead links

2022-03-19T18:21:14Z

Other python pages: Add link to orphaned page and remove dead links

@@ Line 103: / Line 103: @@
-=== Other python pages ===
+=== Other Python pages ===
-There are several other pages in the Kodi Online Manual dedicated to Python development. You can find a comprehensive list by clicking "Python" in the Categories list at the bottom of any Python page.
+There are several other pages in the Kodi Online Manual dedicated to Python development. You can find a comprehensive list by clicking "Python" in the Categories list at the bottom of any Python page. Definitely check out following pages with tons of great sample code.
 * [[Python debugging]]
+* [[Python Problems]]
 * [[HOW-TO:HelloWorld_addon]]
 * [[Script_lyrics]]
 * [[Script_sources]]
 * [[Add-on unicode paths]]
-Need to clean this up:
+==== General Python info ====
+* [https://docs.python.org/3/ Official Python 3 documentation]
-* [http://forum.kodi.tv/showthread.php?tid=99082| GUIDE HOW TO ADD A LOGIN FUNCTION TO YOUR ADDON]
+* [https://stackoverflow.com/questions/tagged/python StackOverflow Python questions]
 == Environment details ==

RogueScholar: added Category:Add-ons using HotCat

2021-08-09T05:23:26Z

added Category:Add-ons using HotCat

← Older revision		Revision as of 05:23, 9 August 2021
Line 184:		Line 184:
	{{top}}		{{top}}
	[[Category:Development]]		[[Category:Development]]
			[[Category:Add-ons]]

Karellen at 21:38, 12 December 2020

2020-12-12T21:38:21Z

← Older revision		Revision as of 21:38, 12 December 2020
Line 1:		Line 1:
	{{mininav\|[[Development]]\|[[Add-on development]]}}		{{mininav\|[[Development]]\|[[Add-on development]]}}

	~~{{cleanup}}~~

	== About Addons ==		== About Addons ==
			Kodi Add-ons are extensions that can be run from inside the Kodi GUI.

	~~Kodi Add-ons are extensions that can be run from inside the Kodi GUI.~~ They are usually written by third party developers and published to our official repository. Add-ons can also be published in other repositories or as stand alone zip files anywhere on the internet. Examples of Add-ons include video website streams, scrapers, skins and scripts.		They are usually written by third party developers and, if the add-on does not breach any rules or policies for inclusion into the official {{kodi}} repository, it can published to our official repository if submitted by the add-on developer. Add-ons can also be published in other repositories or as stand alone zip files anywhere on the internet. Examples of Add-ons include video website streams, scrapers, skins and scripts.

	Kodi Add-ons are typically written in python. There are also binary addons used for applications like PVR, Inputstreams, AudioEncoders, Screensavers etc.		Kodi Add-ons are typically written in python. There are also binary addons used for applications like PVR, Inputstreams, AudioEncoders, Screensavers etc.

	Each time a new version of Kodi is released we add new features which may lead to a break compatibility. It is up to the author to update their add-on to remain compatible.		Each time a new version of Kodi is released we add new features which may lead to a break compatibility. It is up to the author to update their add-on to remain compatible.



	== Add-on system (v19+ Matrix) ==		== Add-on system (v19+ Matrix) ==

	Add-ons are of three types:		Add-ons are of three types:
	* '''System add-ons''' - Installed by kodi, add-ons of this type can only ever be updated by the system.		* '''System add-ons''' - Installed by kodi, add-ons of this type can only ever be updated by the system.
Line 21:		Line 22:

	Add-ons installed from private repositories can only be auto updated from their own repository, or from an official repository. If the same add-on is contained in two different private repositories and the version installed is from one of those repositories the only way to install the other version is via the '''Update''' button in the add-on info UI.		Add-ons installed from private repositories can only be auto updated from their own repository, or from an official repository. If the same add-on is contained in two different private repositories and the version installed is from one of those repositories the only way to install the other version is via the '''Update''' button in the add-on info UI.



	== Addon system using python ==		== Addon system using python ==
Line 26:		Line 29:

	This page is intended as an introduction to Kodi Python for new developers, and a quick reference for more experienced programmers. If you're not interested in programming, you might want to visit [[Add-ons\|this page]] for information about installing and using Python add-ons as an end user.		This page is intended as an introduction to Kodi Python for new developers, and a quick reference for more experienced programmers. If you're not interested in programming, you might want to visit [[Add-ons\|this page]] for information about installing and using Python add-ons as an end user.



	== PyDocs ==		== PyDocs ==
			The very latest Kodi python API documentation "''PyDocs''" with classes and functions is automatically generated from XBMC's source code and can be found here (not all functions are available in previous versions): https://codedocs.xyz/xbmc/xbmc/group__python.html (for Kodi 17.x Krypton and onwards)


	The very latest Kodi python API documentation "''PyDocs''" with classes and functions is automatically generated from XBMC's source code and can be found here (not all functions are available in previous versions): https://codedocs.xyz/xbmc/xbmc/group__python.html (for Kodi 17.x Krypton and onwards)

	== Python plugins versus scripts ==		== Python plugins versus scripts ==
Line 40:		Line 46:

	Do not try to mix and match script and plugin functionality as that will only give you weird error messages.		Do not try to mix and match script and plugin functionality as that will only give you weird error messages.



	== Script development ==		== Script development ==
Line 49:		Line 57:

	There are some excellent tutorials available to introduce you to Kodi scripting (and Python in general).		There are some excellent tutorials available to introduce you to Kodi scripting (and Python in general).



	== Plugin development ==		== Plugin development ==
Line 56:		Line 66:

	Plugins are most commonly used to scrape websites for links to streaming videos, displaying the video list in Kodi just like it would movie files on the local hard drive.		Plugins are most commonly used to scrape websites for links to streaming videos, displaying the video list in Kodi just like it would movie files on the local hard drive.



	== Resource links ==		== Resource links ==
	While the three custom libraries give you control over the Kodi GUI, you'll eventually want to be able to interact with other parts of the system. Much of Kodi's functionality is exposed to Python, one way or another. These are some of the systems you can use to make your Python add-ons more useful.		While the three custom libraries give you control over the Kodi GUI, you'll eventually want to be able to interact with other parts of the system. Much of Kodi's functionality is exposed to Python, one way or another. These are some of the systems you can use to make your Python add-ons more useful.



	=== Must read ===		=== Must read ===

	A must read for developers is [http://www.python.org/dev/peps/pep-0008/ style guide] for writing python.		A must read for developers is [http://www.python.org/dev/peps/pep-0008/ style guide] for writing python.
	This contains the do's and dont's when starting to write code.		This contains the do's and dont's when starting to write code.



Line 70:		Line 84:

	[[List_of_built-in_functions\|List of Built In Functions]]		[[List_of_built-in_functions\|List of Built In Functions]]



	=== Kodi databases (media metadata libraries) ===		=== Kodi databases (media metadata libraries) ===
Line 75:		Line 91:

	{{tip\|See [[Databases]] for database layout}}		{{tip\|See [[Databases]] for database layout}}



	=== InfoLabels ===		=== InfoLabels ===
Line 82:		Line 100:

	{{see\|InfoLabels}}		{{see\|InfoLabels}}



	=== Other python pages ===		=== Other python pages ===
Line 141:		Line 161:

	* http://wwwsearch.sourceforge.net/ClientForm/		* http://wwwsearch.sourceforge.net/ClientForm/



	== Environment details ==		== Environment details ==
	Kodi comes with Python 2.7		Kodi comes with Python 2.7



	== Migration to Python 3 ==		== Migration to Python 3 ==
	[[Migration to Python 3]]		[[Migration to Python 3]]



Line 157:		Line 181:
	:With the release of Isengard 15.0, some functions are out of date. Please view http://kodi.wiki/view/Isengard_API_changes for the latest on incorporating Python scripts.		:With the release of Isengard 15.0, some functions are out of date. Please view http://kodi.wiki/view/Isengard_API_changes for the latest on incorporating Python scripts.
	:With the release of Jarvis 16.0, some functions are out of date. Please view http://kodi.wiki/view/Jarvis_API_changes for the latest on incorporating Python scripts.		:With the release of Jarvis 16.0, some functions are out of date. Please view http://kodi.wiki/view/Jarvis_API_changes for the latest on incorporating Python scripts.

			{{top}}
			[[Category:Development]]

Karellen at 03:35, 12 September 2020

2020-09-12T03:35:44Z

← Older revision		Revision as of 03:35, 12 September 2020
Line 87:		Line 87:
	Definitely check out following pages with tons of great sample code.		Definitely check out following pages with tons of great sample code.

	* [[~~HOW-TO:Debug_python_scripts~~]]		* [[Python debugging]]

	* [[HOW-TO:HelloWorld_addon]]		* [[HOW-TO:HelloWorld_addon]]

Karellen at 21:33, 29 August 2020

2020-08-29T21:33:06Z

← Older revision		Revision as of 21:33, 29 August 2020
Line 86:		Line 86:
	There are several other pages in the Kodi Online Manual dedicated to Python development. You can find a comprehensive list by clicking "Python" in the Categories list at the bottom of any Python page.		There are several other pages in the Kodi Online Manual dedicated to Python development. You can find a comprehensive list by clicking "Python" in the Categories list at the bottom of any Python page.
	Definitely check out following pages with tons of great sample code.		Definitely check out following pages with tons of great sample code.

	* [[HOW-TO:Upgrade Python interpreter on Linux]]

	* [[HOW-TO:Debug_python_scripts]]		* [[HOW-TO:Debug_python_scripts]]
Line 145:		Line 143:

	== Environment details ==		== Environment details ==
	~~{{see also\|HOW-TO:Upgrade~~ Python ~~interpreter on Linux}}~~		Kodi comes with Python 2.7

	~~Kodi comes with Python 2.7~~

	== Migration to Python 3 ==		== Migration to Python 3 ==
			[[Migration to Python 3]]

	~~[[Migration to Python 3]]~~

	== Out of Date ==		== Out of Date ==

Phunkyfish: Update with new addon system constraints for v19+

2020-07-31T08:57:22Z

Update with new addon system constraints for v19+

← Older revision		Revision as of 08:57, 31 July 2020
Line 7:		Line 7:
	Kodi Add-ons are extensions that can be run from inside the Kodi GUI. They are usually written by third party developers and published to our official repository. Add-ons can also be published in other repositories or as stand alone zip files anywhere on the internet. Examples of Add-ons include video website streams, scrapers, skins and scripts.		Kodi Add-ons are extensions that can be run from inside the Kodi GUI. They are usually written by third party developers and published to our official repository. Add-ons can also be published in other repositories or as stand alone zip files anywhere on the internet. Examples of Add-ons include video website streams, scrapers, skins and scripts.

	Kodi Add-ons are typically written in python.		Kodi Add-ons are typically written in python. There are also binary addons used for applications like PVR, Inputstreams, AudioEncoders, Screensavers etc.

	~~Add-ons should work with the latest Krypton Release.~~ Each time a new version of Kodi is released we add new features which may lead to a break compatibility. It is up to the author to update their add-on to remain compatible.		Each time a new version of Kodi is released we add new features which may lead to a break compatibility. It is up to the author to update their add-on to remain compatible.

			== Add-on system (v19+ Matrix) ==

			Add-ons are of three types:
			* '''System add-ons''' - Installed by kodi, add-ons of this type can only ever be updated by the system.
			* '''Official repository add-ons''' - Add-ons contained in the official kodi repository. This repository list is compiled into Kodi.
			* '''Private repository add-ons''' - Add-ons loaded from a private repository. In order to be able to install private repositories and add-ons the setting '''System->Add-ons->Unknown Sources''' must be enabled.

			By default Official repository add-ons will only auto update from the official repositories. In the case of beta repos the setting '''System->Add-ons->Update official add-ons from''' must be set to '''Any repositories''' to allow an official add-on to be auto updated to a later version from a private repository.

			Add-ons installed from private repositories can only be auto updated from their own repository, or from an official repository. If the same add-on is contained in two different private repositories and the version installed is from one of those repositories the only way to install the other version is via the '''Update''' button in the add-on info UI.

	== Addon system using python ==		== Addon system using python ==

Karellen at 01:56, 26 July 2020

2020-07-26T01:56:32Z

← Older revision		Revision as of 01:56, 26 July 2020
Line 37:		Line 37:
	That's the same code you would enter at the Python command line, because Kodi runs a full-featured, standard Python interpreter (for more information concerning the current version number and included modules see the [[#Environment details\|environment details]] below). If you're already familiar with Python programming, the only new challenge is learning the [[#PyDocs\|custom modules]] that allow you to gather information from Kodi and manipulate the Graphical User Interface (GUI).		That's the same code you would enter at the Python command line, because Kodi runs a full-featured, standard Python interpreter (for more information concerning the current version number and included modules see the [[#Environment details\|environment details]] below). If you're already familiar with Python programming, the only new challenge is learning the [[#PyDocs\|custom modules]] that allow you to gather information from Kodi and manipulate the Graphical User Interface (GUI).

	There are some excellent tutorials available to introduce you to Kodi scripting (and Python in general~~). See the [[Archive:Write_python_scripts\|HOW-TO]] included in the Kodi Online Manual, or visit Alexpoet's Kodi Scripting site for a popular beginner's tutorial (PDF~~).		There are some excellent tutorials available to introduce you to Kodi scripting (and Python in general).

	== Plugin development ==		== Plugin development ==
Line 75:		Line 75:
	There are several other pages in the Kodi Online Manual dedicated to Python development. You can find a comprehensive list by clicking "Python" in the Categories list at the bottom of any Python page.		There are several other pages in the Kodi Online Manual dedicated to Python development. You can find a comprehensive list by clicking "Python" in the Categories list at the bottom of any Python page.
	Definitely check out following pages with tons of great sample code.		Definitely check out following pages with tons of great sample code.

	* [[Archive:Write_Python_Scripts]]

	* [[HOW-TO:Upgrade Python interpreter on Linux]]		* [[HOW-TO:Upgrade Python interpreter on Linux]]

	* [[HOW-TO:~~Debug Python Scripts with Eclipse\|HOW-TO:Debug_Python_Scripts_with_Eclipse~~]]		* [[HOW-TO:Debug_python_scripts]]

	* [[HOW-TO:HelloWorld_addon]]		* [[HOW-TO:HelloWorld_addon]]

	* [[HOW-TO:DebugAndDevelopPythonScriptsWithVisualStudio\|HOW-TO:Debug and Develop Python Scripts with Visual Studio]]

	* [[HOW-TO:Debug Python Scripts with Web-PDB]]

	* [[Script_lyrics]]		* [[Script_lyrics]]

Karellen at 03:06, 11 July 2020

2020-07-11T03:06:58Z

← Older revision		Revision as of 03:06, 11 July 2020
Line 155:		Line 155:
	:With the release of Isengard 15.0, some functions are out of date. Please view http://kodi.wiki/view/Isengard_API_changes for the latest on incorporating Python scripts.		:With the release of Isengard 15.0, some functions are out of date. Please view http://kodi.wiki/view/Isengard_API_changes for the latest on incorporating Python scripts.
	:With the release of Jarvis 16.0, some functions are out of date. Please view http://kodi.wiki/view/Jarvis_API_changes for the latest on incorporating Python scripts.		:With the release of Jarvis 16.0, some functions are out of date. Please view http://kodi.wiki/view/Jarvis_API_changes for the latest on incorporating Python scripts.



	~~[[Category:Development-Archived]]~~

Karellen at 03:06, 11 July 2020

2020-07-11T03:06:42Z

← Older revision		Revision as of 03:06, 11 July 2020
Line 14:		Line 14:
	Kodi includes a built-in [http://en.wikipedia.org/wiki/Python_%28programming_language%29 Python interpreter] that allows users to develop add-ons (scripts and plugins) that interface easily and cleanly with the Kodi dashboard. These add-ons can extend the functionality of Kodi without requiring extensive programming experience or ability. While you may not feel comfortable browsing the Kodi source code and submitting patches (or even bug reports), you can learn how to write a script or plugin with just a few hours' practice, using the information available in these pages.		Kodi includes a built-in [http://en.wikipedia.org/wiki/Python_%28programming_language%29 Python interpreter] that allows users to develop add-ons (scripts and plugins) that interface easily and cleanly with the Kodi dashboard. These add-ons can extend the functionality of Kodi without requiring extensive programming experience or ability. While you may not feel comfortable browsing the Kodi source code and submitting patches (or even bug reports), you can learn how to write a script or plugin with just a few hours' practice, using the information available in these pages.

	This page is intended as an introduction to Kodi Python for new developers, and a quick reference for more experienced programmers. If you're not interested in programming, you might want to visit [[Add-ons\|this page]] for information about installing and using Python add-ons as an end user. If you're already familiar with Kodi Python, you can probably skip on down to the [[Python Development#Environment details\|environment details]] or the [[Python Development#Resource links\|resource links]] below for quick reference material.		This page is intended as an introduction to Kodi Python for new developers, and a quick reference for more experienced programmers. If you're not interested in programming, you might want to visit [[Add-ons\|this page]] for information about installing and using Python add-ons as an end user.

	== PyDocs ==		== PyDocs ==
Line 37:		Line 37:
	That's the same code you would enter at the Python command line, because Kodi runs a full-featured, standard Python interpreter (for more information concerning the current version number and included modules see the [[#Environment details\|environment details]] below). If you're already familiar with Python programming, the only new challenge is learning the [[#PyDocs\|custom modules]] that allow you to gather information from Kodi and manipulate the Graphical User Interface (GUI).		That's the same code you would enter at the Python command line, because Kodi runs a full-featured, standard Python interpreter (for more information concerning the current version number and included modules see the [[#Environment details\|environment details]] below). If you're already familiar with Python programming, the only new challenge is learning the [[#PyDocs\|custom modules]] that allow you to gather information from Kodi and manipulate the Graphical User Interface (GUI).

	There are some excellent tutorials available to introduce you to Kodi scripting (and Python in general). See the [[~~HOW-TO write Python Scripts~~\|HOW-TO]] included in the Kodi Online Manual, or visit Alexpoet's Kodi Scripting site for a popular beginner's tutorial (PDF).		There are some excellent tutorials available to introduce you to Kodi scripting (and Python in general). See the [[Archive:Write_python_scripts\|HOW-TO]] included in the Kodi Online Manual, or visit Alexpoet's Kodi Scripting site for a popular beginner's tutorial (PDF).

	== Plugin development ==		== Plugin development ==
Line 58:		Line 58:
	You can call any of the Kodi Built-in Commands using the function xbmc.executebuiltin().		You can call any of the Kodi Built-in Commands using the function xbmc.executebuiltin().

	[[List of Built In Functions]]		[[List_of_built-in_functions\|List of Built In Functions]]

	=== Kodi databases (media metadata libraries) ===		=== Kodi databases (media metadata libraries) ===
	Kodi uses [[~~Music Library~~\|Music]] and [[~~Video Library~~\|Video]] Libraries, stored in a SQL (SQLite) database, to store massive amounts of additional meta data concerning local media files (assuming the user has enabled the libraries and chosen the right Content and scraper for each of his sources). Although there's no direct access from Python to the Kodi Database, you can gain access to the databases from Python through the [[JSON ~~RPC~~]]. Read more about that [[~~The Kodi Database#Accessing the~~ Databases ~~with Kodi Python~~\|here]].		Kodi uses [[Music_library\|Music]] and [[Video_library\|Video]] Libraries, stored in a SQL (SQLite) database, to store massive amounts of additional meta data concerning local media files (assuming the user has enabled the libraries and chosen the right Content and scraper for each of his sources). Although there's no direct access from Python to the Kodi Database, you can gain access to the databases from Python through the [[JSON-RPC_API]]. Read more about that [[Databases\|here]].

	{{tip\|See [[Databases]] for database layout}}		{{tip\|See [[Databases]] for database layout}}
Line 76:		Line 76:
	Definitely check out following pages with tons of great sample code.		Definitely check out following pages with tons of great sample code.

	* [[~~HOW-TO write Python Scripts~~]]		* [[Archive:Write_Python_Scripts]]

	* [[HOW-TO:Upgrade Python interpreter on Linux]]		* [[HOW-TO:Upgrade Python interpreter on Linux]]
Line 88:		Line 88:
	* [[HOW-TO:Debug Python Scripts with Web-PDB]]		* [[HOW-TO:Debug Python Scripts with Web-PDB]]

	* [[~~Script Lyrics~~]]		* [[Script_lyrics]]

	* [[~~Script Sources~~]]		* [[Script_sources]]

	* [[Add-on unicode paths]]		* [[Add-on unicode paths]]
Line 156:		Line 156:
	:With the release of Jarvis 16.0, some functions are out of date. Please view http://kodi.wiki/view/Jarvis_API_changes for the latest on incorporating Python scripts.		:With the release of Jarvis 16.0, some functions are out of date. Please view http://kodi.wiki/view/Jarvis_API_changes for the latest on incorporating Python scripts.

	~~== See also ==~~
	* [[Add-ons]]
	* [[:Category:All add-ons]]
	* [[Unofficial add-on repositories]]
	~~'''Development:'''~~
	* [[Add-on development]]
	* [[Skinning]]
	* [[Add-on repositories]]
	* [[Official add-on repository]]

	~~[[Category:Add-on development]]~~
	[[Category:Development]]		[[Category:Development-Archived]]
	~~[[Category:Python~~]]

Karellen at 22:16, 16 June 2020

2020-06-16T22:16:42Z

← Older revision		Revision as of 22:16, 16 June 2020
Line 77:		Line 77:

	* [[HOW-TO write Python Scripts]]		* [[HOW-TO write Python Scripts]]

	* [[HOW-TO:Write_Python_Scripts_for_XBMC]]

	* [[HOW-TO write plugins for XBMC]]

	* [[HOW-TO:Upgrade Python interpreter on Linux]]		* [[HOW-TO:Upgrade Python interpreter on Linux]]