Jellyfin API Client
Python interface to Jellyfin Instance
Installation
1. Clone Project
Clone the project from GitHub:
git clone https://github.com/radityaharya/jellyfinapi
2. Change Directory
cd jellyfinapi
3. Install Dependencies
pip install -r requirements.txt
4. Install Package
pip install .
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
- Activity Log
- Api Key
- Artists
- Audio
- Branding
- Channels
- Client Log
- Collection
- Configuration
- Dashboard
- Devices
- Display Preferences
- Dlna
- Dlna Server
- Dynamic Hls
- Endpoints
- Environment
- Filter
- Genres
- Hls Segment
- Image
- Image by Name
- Instant Mix
- Item Lookup
- Item Refresh
- Items
- Item Update
- Library
- Library Structure
- Live Tv
- Localization
- Media Info
- Movies
- Music Genres
- Notifications
- Open Subtitles
- Package
- Persons
- Playlists
- Playstate
- Plugins
- Quick Connect
- Remote Image
- Scheduled Tasks
- Search
- Session
- Startup
- Studios
- Subtitle
- Suggestions
- Sync Play
- System
- Time Sync
- Tmdb
- Trailers
- Trakt
- Tv Shows
- Universal Audio
- User
- User Library
- User Views
- Video Attachments
- Videos
- Years
Classes Documentation
1 maintainer
Metadata
1 maintainer
Release files for jellyfinapi 10.8.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| jellyfinapi-10.8.5.tar.gz | 312.4 kB | Without provenance | Details for jellyfinapi-10.8.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| jellyfinapi-10.8.5-py3-none-any.whl | Python 3 | none | any | Details for jellyfinapi-10.8.5-py3-none-any.whl |
Total release size: 954.0 kB
Release files / jellyfinapi-10.8.5.tar.gz
| Download URL | jellyfinapi-10.8.5.tar.gz |
|---|---|
| Size | 312.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6eac8b65c3222026942ec711a99c522306e915cd3acc416a4bf2c9abfc631c8a
|
|
BLAKE2b-256 checksum How to use checksums |
0ebb7a50722a4ce9efd7022004b0bea6f97a101f13220dabcadddc24600f544c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.14
|
Release files / jellyfinapi-10.8.5-py3-none-any.whl
| Download URL | jellyfinapi-10.8.5-py3-none-any.whl |
|---|---|
| Size | 641.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
39ce4bae3db7cd31c0792ec30922a1dc87237e7edebea62a3a55744e9af96e81
|
|
BLAKE2b-256 checksum How to use checksums |
ef3ff76bf450f95b4a719730614badb13dba3cbdd8eb692349255bf744018ef7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.14
|
Security for jellyfinapi 10.8.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
