Stub modules that re-create Kodi Python API


Keywords
kodi, documentation, inspection
License
GPL-3.0
Install
pip install Kodistubs==19.0.3

Documentation

Kodistubs

(former xbmcstubs)

Kodi stubs are Python files that can help you develop addons for Kodi (XBMC) Media Center. Use them in your favorite IDE to enable autocompletion and view docstrings for Kodi Python API functions, classes and methods. Kodistubs also include PEP-484 type annotations for all functions and methods.

You can install Kodistubs into your working virtual environment using pip:

$ pip install Kodistubs

Read Kodi stubs documentation for more info on how to use Kodi stubs.

Kodistubs major version corresponds to the version of Kodi they have been generated from. Current Kodistubs are compatible with Python 3.6 and above. Kodistubs for Kodi versions that used Python 2.x for addons can be found in python2 branch.

Warning: Kodistubs are literally stubs and do not include any useful code, so don't try to run your program outside Kodi unless you add some testing code into Kodistubs or use some mocking library to mock Kodi Python API.

Current Kodistubs have been generated from scratch using Doxygen XML files and SWIG XML Python binding definitions that, in their turn, have been generated from Kodi sources. Old Kodistubs can be found in legacy branch.

I try to keep Kodi stubs in sync with Kodi Python API development, but it may happen that I miss something. Don't hesitate to open issues or submit pull requests if you notice discrepancies with the actual state of Kodi Python API.

Discussion topic on Kodi forum

License: GPL v.3