Skip to main content

A complete Python client for the Kodi JSON-RPC API

Project description

A complete Python client for the Kodi JSON-RPC API

Why?

Because JSON-RPC is one of the trickier communication schemes to write for. And if you want to code for it, then you’re probably going to get into bit of a dysfunctional relationship with the documentation.

What?

A native-Python JSON-RPC client. Loads all the methods from your Kodi instance each time it gets instantiated, so you know you’re never behind. And, it puts it in some semblance of a reasonable object structure.

Future updates will bundle a carefully-manicured static hive that will give you a better object structure at the cost of not always being completely up-to-date.

How?

>>> from kodipydent import Kodi
>>> my_kodi = Kodi('192.168.1.1')
>>> movies = my_kodi.VideoLibrary.GetMovies()

Simple as that. beekeeper makes it easy to use and easy to learn; if you don’t know the name of the method you want to use, just do this:

>>> print(my_kodi)

and you’ll get a printout of all the methods available, and all the variables each one takes.

Installation

$ pip install kodipydent

Under the Hood

kodipydent is driven by beekeeper, the family-friendly, object-oriented Python REST library. With beekeeper, even JSON-RPC clients are relatively simple to write. Don’t believe me? Read the code. And you can check out kodipydent/hive.json to see what a full hive looks like.

Here’s the full signature of the method to create your API:

Kodi(hostname[, port=8080, username='kodi', password=None])

“Advanced” Usage

kodipydent supports Kodi installations that have usernames and passwords set up. If you’ve created a password for web access, then simply construct your kodipydent instance as follows:

Kodi('localhost', username='kodi', password='myawesomepassword')

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

kodipydent-alt-2022.9.3.tar.gz (12.8 kB view hashes)

Uploaded Source

Built Distribution

kodipydent_alt-2022.9.3-py3-none-any.whl (11.9 kB view hashes)

Uploaded Python 3

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