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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for Kodistubs-20.0.0a2.tar.gz
Algorithm Hash digest
SHA256 853bfd38342a8e62ee5da1cc3918b91af73cbfce6f943286b1f5ddab23bee508
MD5 bd1010650c3ca32c4326931323e9fb5b
BLAKE2b-256 dd193ce0fb7554dbff28c558019536c3db588e75dc8a2b3b459d45bc2060b6ee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Kodistubs-20.0.0a2-py3-none-any.whl
  • Upload date:
  • Size: 71.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for Kodistubs-20.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 9527f496d52552b8d1c66117012927434060605ba45d70a5e0a2a57ef24eea80
MD5 3f66481961f02eab20d07349de9a5b46
BLAKE2b-256 ed6855c301996ebe57bc1e515b61e321f54e651796107a051680b17f2f1b3cbd

See more details on using hashes here.

Supported by

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