Skip to main content

Python API client for Jellyfin

Project description

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.

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

jellyfin-apiclient-python-1.1.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

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

jellyfin_apiclient_python-1.1.0-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

Details for the file jellyfin-apiclient-python-1.1.0.tar.gz.

File metadata

  • Download URL: jellyfin-apiclient-python-1.1.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for jellyfin-apiclient-python-1.1.0.tar.gz
Algorithm Hash digest
SHA256 bd6a063545dfc7e217532d277c0996a0d75ac6ed1d806c2f7fb61d74e0f8f99c
MD5 0b03a3c8876130360906ab729ca5e159
BLAKE2b-256 7370c35b133d8aafe8e93f23bb5d5580a8b4935b934d0a779015a4f91df54d21

See more details on using hashes here.

File details

Details for the file jellyfin_apiclient_python-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: jellyfin_apiclient_python-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 29.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for jellyfin_apiclient_python-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c28cfdf0f16eaabd2a1468f8339d944ba9ff07f47bf42211e2a19be7891c4cc
MD5 1a084e41df6e0b880b53c6b181e80f52
BLAKE2b-256 e8e45bd3ab459230012584a4076da16777784b556fbb6ed40eb1ab00493cd38b

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