Metadata-Version: 2.1
Name: pykodi
Version: 0.2.7
Summary: An async python interface for Kodi over JSON-RPC.
Home-page: https://github.com/OnFreund/PyKodi
Author: On Freund
Author-email: onfreund@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonrpc-async (>=2.0.0)
Requires-Dist: jsonrpc-websocket (>=3.0.0)
Requires-Dist: aiohttp


# PyKodi

An async python interface for [Kodi](https://kodi.tv/) over JSON-RPC.
This is mostly designed to integrate with HomeAssistant. If you have other needs, there might be better packages available.

## Installation

You can install PyKodi from [PyPI](https://pypi.org/project/pykodi/):

    pip3 install pykodi

Python 3.7 and above are supported.


## How to use

```python
from pykodi import get_kodi_connection, Kodi
kc = get_kodi_connection(<host>, <port>, <ws_port>, <username>, <password>, <ssl>, <timeout>, <session>)
# if ws_port is None the connection will be over HTTP, otherwise over WebSocket.
# ssl defaults to False (only relevant if you have a proxy), timeout to 5 (seconds)
# session is generated if not passed in

# you can also pass in your own session
await kc.connect()

kodi = Kodi(kc)

await kodi.ping()
properties = await kodi.get_application_properties(["name", "version"])

await kodi.play()
await kodi.volume_up()
await kodi.pause()
...
```