jellyfin/jellyfin-apiclient-python
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin-apiclient-python.git synced 2024-11-23 13:59:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
9e185cf921
jellyfin-apiclient-python/README.md
Ian Walton 9e185cf921 Initial commit.
2020-01-15 09:16:41 -05:00

1.8 KiB
Raw Blame History

Jellyfin ApiClient Python

This is the API client from Jellyfin Kodi extracted as a python package so that other users may use the API without maintaining a fork of the API client. Please note that this API client is not complete. You may have to add API calls to perform certain tasks. Please see Contributing below.

Usage

This client can be installed with pip3 install jellyfin-apiclient-python and imported with import jellyfin_apiclient_python.

There is no documentation for this API at this time. For information on how to create a client and establish a session, please see clients.py from Jellyfin MPV Shim. For details on what the individual API calls do or how to do a certain task, you will probably find the Jellyfin MPV Shim and Jellyfin Kodi repositories useful.

Changes from Jellyfin Kodi

  • Removal of websocket.py (now a dependency to websocket_client).
  • Removal of dependencies on helper (from Jellyfin Kodi) and kodi_six.
  • Add has_attribute directly to __init__.py.
  • Add API call get_season for fetching season metadata.
  • Add parameters aid=None, sid=None, start_time_ticks=None, is_playback=True to API call get_play_info.
  • Remove dependency to six from http.py.

Contributing

When contributing, please maintain backward compatibility with existing calls in the API. Adding parameters is fine, but please make sure that they have default options to prevent existing software from breaking. Please also add your changes to the Changes from Jellyfin Kodi section.

If you would like to produce documentation for this API, I would also be interested in accepting pull requests for documentation.