Skip to main content

Stub modules that re-create Kodi Python API

Project description

https://badge.fury.io/py/Kodistubs.svg

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

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-20.0.0rc2.tar.gz (69.6 kB view details)

Uploaded Source

Built Distribution

Kodistubs-20.0.0rc2-py3-none-any.whl (71.1 kB view details)

Uploaded Python 3

File details

Details for the file Kodistubs-20.0.0rc2.tar.gz.

File metadata

  • Download URL: Kodistubs-20.0.0rc2.tar.gz
  • Upload date:
  • Size: 69.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for Kodistubs-20.0.0rc2.tar.gz
Algorithm Hash digest
SHA256 794f1cf758403d351f2e0dca14528a2a2efe76e3b96fe55d029792a5a03a873f
MD5 d3a3d9c5b1483847f1ffb39273ed8d51
BLAKE2b-256 83e9b71bda917782933a1012fc9115019df3b48e86d75dadbb932f903b046c9a

See more details on using hashes here.

File details

Details for the file Kodistubs-20.0.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for Kodistubs-20.0.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 63a8089f2ad728f323bf0129419e3883f97fbcbe37ddffe3e4b2a498dfeb5105
MD5 2a6ffb419a0d8f6ecfcbaed08f9c660b
BLAKE2b-256 5946e120039db74b2679ffeaa5a64e76f73da8d671c38c86aa3b904f858a243c

See more details on using hashes here.

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