jellyfin-sdk 0.1.1

A Possible Official Python SDK for Jellyfin.

jellyfin-sdk-python

---

A Possible Official Python SDK for Jellyfin.

Warning: This project is under active development, so API changes may occur.

This project is mainly inspired by good python library like these:

• tmdbsimple
• plexapi
• tensorflow

Main unique features:

• Supports targeting the Jellyfin server version to maintain compatibility.
• It is possible to access multiple servers with different versions.
• Allows gradually increasing the depth of access to more primitive objectives.
• Works like AWS CDK Constructs Level, more abstraction, more simple.

Install

pip install jellyfin-sdk

or

uv add jellyfin-sdk

Usage

Drop-in replacement for jellyfin-apiclient-python

This library inject the old legacy (almost not maintained) for help migration:

# from
from jellyfin_apiclient_python import JellyfinClient
from jellyfin_apiclient_python.api import API

# to 
from jellyfin.legacy import JellyfinClient
from jellyfin.legacy.api import API

Login

Let's start with login, most cases you only need do something simple:

import os

os.environ["JELLYFIN_URL"] = "https://jellyfin.example.com"
os.environ["JELLYFIN_API_KEY"] = "MY_TOKEN"

Legacy (jellyfin-apiclient-python)

from jellyfin.legacy import JellyfinClient
client = JellyfinClient()
client.authenticate(
    {"Servers": [{
        "AccessToken": os.getenv("JELLYFIN_API_KEY"), 
        "address": os.getenv("JELLYFIN_URL")
    }]}, 
    discover=False
)
system_info = client.jellyfin.get_system_info()

print(system_info.get("Version"), system_info.get("ServerName"))

Generated Binding with OpenAPI Specification

from jellyfin.generated.api_10_10 import Configuration, ApiClient, SystemApi

client = ApiClient(
    Configuration(host = os.getenv("JELLYFIN_URL")), 
    header_name='X-Emby-Token', 
    header_value=os.getenv("JELLYFIN_API_KEY")
)
system_info = SystemApi(client).get_system_info()

print(system_info.version, system_info.server_name)

Lean optimized access

import jellyfin

api = jellyfin.api(os.getenv("JELLYFIN_URL"), os.getenv("JELLYFIN_API_KEY"))

print(api.system.info.version, api.system.info.server_name)

Jellyfin Server API Version

This is important because when a new API version come to live breaking changes can broke the entire project, to avoid this problem is possible to set a API Target, like in Android:

from jellyfin.api import Version
import jellyfin

# this will use the default which is the lastest stable
jellyfin.api(os.getenv("JELLYFIN_URL"), os.getenv("JELLYFIN_API_KEY"))

# now let's test the new API (version 10.11) for breaking changes in same endpoint
jellyfin.api(os.getenv("JELLYFIN_URL"), os.getenv("JELLYFIN_API_KEY"), Version.V10_11)

# but keep simple
jellyfin.api(os.getenv("JELLYFIN_URL"), os.getenv("JELLYFIN_API_KEY"), '10.11')

# let's test a wrong version
jellyfin.api(os.getenv("JELLYFIN_URL"), os.getenv("JELLYFIN_API_KEY"), '99')

Supported Jellyfin Versions

SDK Version	Jellyfin API Target
0.1.x	10.10.x-10.11.x