Skip to main content

SAKÉ can help you to debug and develop Kodi Python add-ons

Project description

SAKÉ: Simple ASCII Kodi Emulator

License GitHub Workflow Status (branch) Quality Gate Status Python

alt text

SAKÉ: your favourite 'drink' for debugging and developing Kodi Python add-ons

SAKÉ can help you to debug and develop Kodi Python add-ons. It contains a set of libraries that try to mimic the functionality of the corresponding Kodi modules:

Module Purpose
xbmc General functions on Kodi
xbmcaddon Kodi’s addon class
xbmcgui GUI functions on Kodi.
xbmcplugin Plugin functions on Kodi.
xbmcvfs Virtual file system functions on Kodi.

Not all libraries are present and certainly not all methods are implemented. Currently missing are:

Module Purpose
xbmcdrm Kodi’s DRM class.

Feel free to contribute to the completion using Pull Requests for this repository.

Using SAKÉ

SAKÉ can be installed using the pip install command:

$ pip install sakee

This will install SAKÉ in the active Python installation. It will be available directly to all your Python scripts. If you choose to not use pip install and want to run it from a specific (custom) location then you will need to include its path the Python paths. Either via:

sys.path.append('<path to SAKÉ>')

Or by appending the SAKÉ path to the Python path environment variable: PYTHONPATH

Configuration

SAKÉ requires you to run with your add-on as the main working directory. Running it outside of that directory will fail.

If your add-on is in a subfolder of Kodi's addons folder, you are done. SAKÉ will try to find its own way and determine what your Kodi path is and where your profile is stored. However, if you are running it standalone, so without Kodi at all, or if SAKÉ got 'drunk' and lost its way, you can always specify some directions using environment variables as follows:

Environment Variable Description
KODI_HOME If specified, will force SAKÉ to look at that path for Kodi's home path.
KODI_PROFILE If specified, will force SAKÉ to use this folder as the Kodi 'master' profile (user_data) folder. This will disable the auto detection of the profile folder based on Kodi's home path.
KODI_ACTIVE_PROFILE SAKÉ will assume that you don't have any Kodi profiles, but in case you have, you can specify what profile to use for the add-on settings.
KODI_INTERACTIVE Normally, SAKÉ will try to interact with you: Whenever there should be a dialog shown within Kodi, SAKÉ will present you with an ASCII version and wait for a response. You can disable this by setting this environment variable to "0". SAKÉ will not disturb you and will continue. However, SAKÉ will answer those dialogs for you and that might result in unwanted actions, but it might come in handy while running unit tests.
KODI_STUB_VERBOSE If set to "1" will make SAKÉ a bit more verbose.
KODI_STUB_RPC_RESPONSES Specifies the folder from which to read JSON RPC responses. If you don't set this, you won't be able to use xbmc.executeJSONRPC
KODI_STUB_INPUT Specify the default input for the keyboard input

JSON RPC responses

In order to respond to the JSON RPC requests, issued via executeJSONRPC, a folder with response files can be configured using the KODI_STUB_RPC_RESPONSES environment variable (see above). This folder should contain response files with the following naming conversions:

<method_name>.json

So, for instance favourites.getfavourites.json. Inside the file there is:

  • A single complete JSON response. In this case, the complete content of the file will be used, as is, as the JSON RPC response.
  • A list of JSON request-response pairs with different input parameters. Using the input parameters of the JSON RPC request, the correct response is determined and returned as the JSON RPC response.

In the latter case, the content of a stub file could look like this:

[
  {
    "request": {
      "params": {
        "setting": "network.usehttpproxy"
      },
      "jsonrpc": "2.0",
      "method": "Settings.GetSettingValue",
      "id": 0
    },
    "response": {
      "id": 5,
      "jsonrpc": "2.0",
      "result": {
        "value": false
      }
    }
  },
  {
    "request": {
      "params": {
        "setting": "network.httpproxyusername"
      },
      "jsonrpc": "2.0",
      "method": "Settings.GetSettingValue",
      "id": 0
    },
    "response": {
      "id": 5,
      "jsonrpc": "2.0",
      "result": {
        "value": true
      }
    }
  }
]

This stub file contains responses for the method Settings.GetSettingValue for the setting network.usehttpproxy and network.httpproxyusername.

If no file with matching method name is found or the file does not contain the correct responses an 'OK' is returned:

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": "OK"
}

Just like most of the Kodi JSON RPC calls do.

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

sakee-0.1.8.tar.gz (47.8 kB view details)

Uploaded Source

Built Distribution

sakee-0.1.8-py3-none-any.whl (47.6 kB view details)

Uploaded Python 3

File details

Details for the file sakee-0.1.8.tar.gz.

File metadata

  • Download URL: sakee-0.1.8.tar.gz
  • Upload date:
  • Size: 47.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for sakee-0.1.8.tar.gz
Algorithm Hash digest
SHA256 f16e390a4a4f7241219912a743a46b0070e8ef86f22a7c8c00a7638af77d5780
MD5 75fe14f787a39c5ee243c15a82c02c06
BLAKE2b-256 05805e280fad9609e22e2f2d7a6889fb9e40c22b5f2d4c97b2696258e0a65d1d

See more details on using hashes here.

File details

Details for the file sakee-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: sakee-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 47.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for sakee-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e4f33770d9279b844df765afe9b22a872d12df5e20cb96ae9ab392d9d44d3a3d
MD5 530e448be9c80b2c7ef85877c354b1bd
BLAKE2b-256 1241a70f1a6ea62b20965b10979a68870767d18960b4343c6316e5cf42bac48a

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