radityaharya / jellyfinapi

Python interface to Jellyfin Instance
14 stars 0 forks source link
jellyfin python

Jellyfin API Client

Python interface to Jellyfin Instance

Installation

1. Install Package

pip install jellyfinapi

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
x_emby_token string API key header parameter

The API client can be initialized as follows:

from jellyfinapi.jellyfinapi_client import JellyfinapiClient
from jellyfinapi.configuration import Environment

client = JellyfinapiClient(
    x_emby_token='api key',
    server_url="your jellyfin server url",)

Authorization

This API uses X-Emby-Token header.

List of APIs

Classes Documentation