Skip to main content

Stub modules that re-create Kodi Python API

Project description

(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 git+

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

**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 Pyhton 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`_

.. _Kodi (XBMC):
.. _Discussion topic on Kodi forum:
.. _GPL v.3:
.. _Kodi stubs documentation:
.. _PEP-484::

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Kodistubs-17.6.1.tar.gz (52.7 kB view hashes)

Uploaded Source

Built Distribution

Kodistubs-17.6.1-py2-none-any.whl (45.7 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page