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 Kodistubs 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 this script from 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-21.0.0.tar.gz (69.8 kB view details)

Uploaded Source

Built Distribution

Kodistubs-21.0.0-py3-none-any.whl (71.4 kB view details)

Uploaded Python 3

File details

Details for the file Kodistubs-21.0.0.tar.gz.

File metadata

  • Download URL: Kodistubs-21.0.0.tar.gz
  • Upload date:
  • Size: 69.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for Kodistubs-21.0.0.tar.gz
Algorithm Hash digest
SHA256 2c342eebf6c85c690788e6a4156a76d8eaa21b4e19e73df601ced0ca28d23576
MD5 fdd2ad7fefee3166fc90906ddad3d1cc
BLAKE2b-256 24bc5cf6fcb211cfcfe572b48897140806c88d2c2ab7597d51dcac2313950304

See more details on using hashes here.

File details

Details for the file Kodistubs-21.0.0-py3-none-any.whl.

File metadata

  • Download URL: Kodistubs-21.0.0-py3-none-any.whl
  • Upload date:
  • Size: 71.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for Kodistubs-21.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b82cf094648ad5c75cf532bc377e1255c71730011d23d664b7df8ac96aedd3e0
MD5 36f563dd27c1362385afbc26c9007baf
BLAKE2b-256 c0687ebaa78fa4ffe81e373419de1aa0aaa5a5f92b378ec616d7696646eecc87

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