Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Stub modules that re-create Kodi Python API

Project description

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 git+https://github.com/romanvm/Kodistubs.git#egg=Kodistubs

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): http://kodi.tv
.. _Discussion topic on Kodi forum: http://forum.kodi.tv/showthread.php?tid=173780
.. _GPL v.3: http://www.gnu.org/licenses/gpl.html
.. _Kodi stubs documentation: http://romanvm.github.io/Kodistubs/
.. _PEP-484:: https://www.python.org/dev/peps/pep-0484/#suggested-syntax-for-python-2-7-and-straddling-code

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
Kodistubs-17.6.1-py2-none-any.whl (45.7 kB) Copy SHA256 hash SHA256 Wheel 2.7
Kodistubs-17.6.1.tar.gz (52.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page