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 calls:
    • get_season for fetching season metadata.
    • get_audio_stream to read an audio stream into a file
    • search_media_items to search for media items
    • audio_url to return the URL to an audio file
  • Add parameters aid=None, sid=None, start_time_ticks=None, is_playback=True to API call get_play_info.
  • Add timesync manager and SyncPlay API methods.
  • Remove usage of six module.
  • Add group of remote_ API calls to remote control another session

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-fix-tls-1.9.1.1.tar.gz (30.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file jellyfin-apiclient-fix-tls-1.9.1.1.tar.gz.

File metadata

File hashes

Hashes for jellyfin-apiclient-fix-tls-1.9.1.1.tar.gz
Algorithm Hash digest
SHA256 e8a8332a90d4049064721d0c6dd19d36d5f2748a63b65f71526d2414f442ae5d
MD5 450693d9558c014fb432692a8a714e25
BLAKE2b-256 581812666e93ecdff4e21df3d0c8d2aad69d30326e00ac43a8775cfc67ce9cd6

See more details on using hashes here.

File details

Details for the file jellyfin_apiclient_fix_tls-1.9.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jellyfin_apiclient_fix_tls-1.9.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d55c37bb1d633b2aa8d3d3f432472f885be27b3cce37928f4437bd85b3884a31
MD5 aae77a038c58bc0c6b5b16b2fb716720
BLAKE2b-256 ff7644e7315f02c0c59a5c1a5482afa9ec5ed1dabfa3f887f653039722be3aea

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