Python Client SDK Generated by Speakeasy
Project description
plexpy
SDK Installation
pip install plex-api-client
SDK Example Usage
Example
import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
pass
Available Resources and Operations
server
- get_server_capabilities - Server Capabilities
- get_server_preferences - Get Server Preferences
- get_available_clients - Get Available Clients
- get_devices - Get Devices
- get_server_identity - Get Server Identity
- get_my_plex_account - Get MyPlex Account
- get_resized_photo - Get a Resized Photo
- get_server_list - Get Server List
media
- mark_played - Mark Media Played
- mark_unplayed - Mark Media Unplayed
- update_play_progress - Update Media Play Progress
video
- get_timeline - Get the timeline for a media item
- start_universal_transcode - Start Universal Transcode
activities
- get_server_activities - Get Server Activities
- cancel_server_activities - Cancel Server Activities
butler
- get_butler_tasks - Get Butler tasks
- start_all_tasks - Start all Butler tasks
- stop_all_tasks - Stop all Butler tasks
- start_task - Start a single Butler task
- stop_task - Stop a single Butler task
hubs
- get_global_hubs - Get Global Hubs
- get_library_hubs - Get library specific hubs
search
- perform_search - Perform a search
- perform_voice_search - Perform a voice search
- get_search_results - Get Search Results
library
- get_file_hash - Get Hash Value
- get_recently_added - Get Recently Added
- get_libraries - Get All Libraries
- get_library - Get Library Details
- delete_library - Delete Library Section
- get_library_items - Get Library Items
- refresh_library - Refresh Library
- search_library - Search Library
- get_metadata - Get Items Metadata
- get_metadata_children - Get Items Children
- get_on_deck - Get On Deck
log
- log_line - Logging a single line message.
- log_multi_line - Logging a multi-line message
- enable_paper_trail - Enabling Papertrail
plex
playlists
- create_playlist - Create a Playlist
- get_playlists - Get All Playlists
- get_playlist - Retrieve Playlist
- delete_playlist - Deletes a Playlist
- update_playlist - Update a Playlist
- get_playlist_contents - Retrieve Playlist Contents
- clear_playlist_contents - Delete Playlist Contents
- add_playlist_contents - Adding to a Playlist
- upload_playlist - Upload Playlist
authentication
- get_transient_token - Get a Transient Token.
- get_source_connection_information - Get Source Connection Information
statistics
- get_statistics - Get Media Statistics
sessions
- get_sessions - Get Active Sessions
- get_session_history - Get Session History
- get_transcode_sessions - Get Transcode Sessions
- stop_transcode_session - Stop a Transcode Session
updater
- get_update_status - Querying status of updates
- check_for_updates - Checking for updates
- apply_updates - Apply Updates
Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
errors.GetServerCapabilitiesResponseBody | 401 | application/json |
errors.SDKError | 4xx-5xx | / |
Example
import plex_api
from plex_api.models import errors
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
res = None
try:
res = s.server.get_server_capabilities()
except errors.GetServerCapabilitiesResponseBody as e:
# handle exception
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
if res.object is not None:
# handle response
pass
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the server_idx: int
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | {protocol}://{ip}:{port} |
protocol (default is http ), ip (default is 10.10.10.47 ), port (default is 32400 ) |
Example
import plex_api
s = plex_api.PlexAPI(
server_idx=0,
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
pass
Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
protocol: models.ServerProtocol
ip: str
port: str
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the server_url: str
optional parameter when initializing the SDK client instance. For example:
import plex_api
s = plex_api.PlexAPI(
server_url="{protocol}://{ip}:{port}",
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
pass
Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
import plex_api
s = plex_api.PlexAPI(
x_plex_client_identifier='<value>',
)
res = s.plex.get_pin(server_url="https://plex.tv/api/v2", strong=False, x_plex_client_identifier='<value>')
if res.object is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import plex_api
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = plex_api.PlexAPI(client=http_client)
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
access_token |
apiKey | API key |
To authenticate with the API the access_token
parameter must be set when initializing the SDK client instance. For example:
import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
pass
Global Parameters
A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set X-Plex-Client-Identifier
to '<value>'
at SDK initialization and then you do not have to pass the same value on calls to operations like get_pin
. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
Available Globals
The following global parameter is available. The required parameter must be set when you initialize the SDK client.
Name | Type | Required | Description |
---|---|---|---|
x_plex_client_identifier | str | ✔️ | The unique identifier for the client application |
This is used to track the client application and its usage | |||
(UUID, serial number, or other number unique per device) |
|
Example
import plex_api
s = plex_api.PlexAPI(
x_plex_client_identifier='<value>',
)
res = s.plex.get_pin(strong=False, x_plex_client_identifier='<value>')
if res.object is not None:
# handle response
pass
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
SDK Created by Speakeasy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for plex_api_client-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb793fa6b2a5c5ac53958b1abb99dd0a9f311b702bc6eb0f74025f824497714f |
|
MD5 | fea3286bdf19889c2db68f3bd2044990 |
|
BLAKE2b-256 | 1b394d27263b55d98b477775db16ae19713f1339e1d51a96dbd44f6a3f6249cf |