plex-api-client 0.20.0__tar.gz → 0.21.0__tar.gz

plex_api_client-0.20.0/README-PYPI.md → plex_api_client-0.21.0/PKG-INFO

@@ -1,3 +1,24 @@
+Metadata-Version: 2.3
+Name: plex-api-client
+Version: 0.21.0
+Summary: Python Client SDK Generated by Speakeasy
+Author: Speakeasy
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: eval-type-backport (>=0.2.0)
+Requires-Dist: httpx (>=0.28.1)
+Requires-Dist: jsonpath-python (>=1.0.6)
+Requires-Dist: pydantic (>=2.10.3)
+Requires-Dist: python-dateutil (>=2.8.2)
+Requires-Dist: typing-inspect (>=0.9.0)
+Project-URL: Repository, https://github.com/LukeHagar/plexpy.git
+Description-Content-Type: text/markdown
+
 # plexpy
 
 <div align="left">
@@ -54,6 +75,7 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
   * [Server Selection](https://github.com/LukeHagar/plexpy/blob/master/#server-selection)
   * [Custom HTTP Client](https://github.com/LukeHagar/plexpy/blob/master/#custom-http-client)
   * [Authentication](https://github.com/LukeHagar/plexpy/blob/master/#authentication)
+  * [Resource Management](https://github.com/LukeHagar/plexpy/blob/master/#resource-management)
   * [Debugging](https://github.com/LukeHagar/plexpy/blob/master/#debugging)
 * [Development](https://github.com/LukeHagar/plexpy/blob/master/#development)
   * [Maturity](https://github.com/LukeHagar/plexpy/blob/master/#maturity)
@@ -64,6 +86,11 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+> [!NOTE]
+> **Python version upgrade policy**
+>
+> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
+
 The SDK can be installed with either *pip* or *poetry* package managers.
 
 ### PIP
@@ -529,6 +556,31 @@ with PlexAPI(
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Resource Management [resource-management] -->
+## Resource Management
+
+The `PlexAPI` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
+
+[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
+
+```python
+from plex_api_client import PlexAPI
+def main():
+    with PlexAPI(
+        access_token="<YOUR_API_KEY_HERE>",
+    ) as plex_api:
+        # Rest of application here...
+
+
+# Or when using async:
+async def amain():
+    async with PlexAPI(
+        access_token="<YOUR_API_KEY_HERE>",
+    ) as plex_api:
+        # Rest of application here...
+```
+<!-- End Resource Management [resource-management] -->
+
 <!-- Start Debugging [debug] -->
 ## Debugging
 
@@ -560,3 +612,4 @@ While we value open-source contributions to this SDK, this library is generated
 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
+

plex_api_client-0.20.0/PKG-INFO → plex_api_client-0.21.0/README-PYPI.md

@@ -1,26 +1,3 @@
-Metadata-Version: 2.1
-Name: plex-api-client
-Version: 0.20.0
-Summary: Python Client SDK Generated by Speakeasy
-Home-page: https://github.com/LukeHagar/plexpy.git
-Author: Speakeasy
-Requires-Python: >=3.8,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: eval-type-backport (>=0.2.0,<0.3.0)
-Requires-Dist: httpx (>=0.28.1,<0.29.0)
-Requires-Dist: jsonpath-python (>=1.0.6,<2.0.0)
-Requires-Dist: pydantic (>=2.10.3,<2.11.0)
-Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
-Requires-Dist: typing-inspect (>=0.9.0,<0.10.0)
-Project-URL: Repository, https://github.com/LukeHagar/plexpy.git
-Description-Content-Type: text/markdown
-
 # plexpy
 
 <div align="left">
@@ -77,6 +54,7 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
   * [Server Selection](https://github.com/LukeHagar/plexpy/blob/master/#server-selection)
   * [Custom HTTP Client](https://github.com/LukeHagar/plexpy/blob/master/#custom-http-client)
   * [Authentication](https://github.com/LukeHagar/plexpy/blob/master/#authentication)
+  * [Resource Management](https://github.com/LukeHagar/plexpy/blob/master/#resource-management)
   * [Debugging](https://github.com/LukeHagar/plexpy/blob/master/#debugging)
 * [Development](https://github.com/LukeHagar/plexpy/blob/master/#development)
   * [Maturity](https://github.com/LukeHagar/plexpy/blob/master/#maturity)
@@ -87,6 +65,11 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+> [!NOTE]
+> **Python version upgrade policy**
+>
+> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
+
 The SDK can be installed with either *pip* or *poetry* package managers.
 
 ### PIP
@@ -552,6 +535,31 @@ with PlexAPI(
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Resource Management [resource-management] -->
+## Resource Management
+
+The `PlexAPI` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
+
+[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
+
+```python
+from plex_api_client import PlexAPI
+def main():
+    with PlexAPI(
+        access_token="<YOUR_API_KEY_HERE>",
+    ) as plex_api:
+        # Rest of application here...
+
+
+# Or when using async:
+async def amain():
+    async with PlexAPI(
+        access_token="<YOUR_API_KEY_HERE>",
+    ) as plex_api:
+        # Rest of application here...
+```
+<!-- End Resource Management [resource-management] -->
+
 <!-- Start Debugging [debug] -->
 ## Debugging
 
@@ -583,4 +591,3 @@ While we value open-source contributions to this SDK, this library is generated
 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
-

{plex_api_client-0.20.0 → plex_api_client-0.21.0}/pyproject.toml

@@ -1,9 +1,20 @@
-[tool.poetry]
+[project]
 name = "plex-api-client"
-version = "0.20.0"
+version = "0.21.0"
 description = "Python Client SDK Generated by Speakeasy"
-authors = ["Speakeasy",]
+authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"
+requires-python = ">=3.9"
+dependencies = [
+    "eval-type-backport >=0.2.0",
+    "httpx >=0.28.1",
+    "jsonpath-python >=1.0.6",
+    "pydantic >=2.10.3",
+    "python-dateutil >=2.8.2",
+    "typing-inspect >=0.9.0",
+]
+
+[tool.poetry]
 repository = "https://github.com/LukeHagar/plexpy.git"
 packages = [
     { include = "plex_api_client", from = "src" }
@@ -16,17 +27,8 @@ include = ["py.typed", "src/plex_api_client/py.typed"]
 [virtualenvs]
 in-project = true
 
-[tool.poetry.dependencies]
-python = "^3.8"
-eval-type-backport = "^0.2.0"
-httpx = "^0.28.1"
-jsonpath-python = "^1.0.6"
-pydantic = "~2.10.3"
-python-dateutil = "^2.8.2"
-typing-inspect = "^0.9.0"
-
 [tool.poetry.group.dev.dependencies]
-mypy = "==1.13.0"
+mypy = "==1.14.1"
 pylint = "==3.2.3"
 types-python-dateutil = "^2.9.0.20240316"
 

plex_api_client-0.21.0/src/plex_api_client/__init__.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from ._version import (
+    __title__,
+    __version__,
+    __openapi_doc_version__,
+    __gen_version__,
+    __user_agent__,
+)
+from .sdk import *
+from .sdkconfiguration import *
+
+
+VERSION: str = __version__
+OPENAPI_DOC_VERSION = __openapi_doc_version__
+SPEAKEASY_GENERATOR_VERSION = __gen_version__
+USER_AGENT = __user_agent__

{plex_api_client-0.20.0 → plex_api_client-0.21.0}/src/plex_api_client/_version.py

@@ -3,7 +3,10 @@
 import importlib.metadata
 
 __title__: str = "plex-api-client"
-__version__: str = "0.20.0"
+__version__: str = "0.21.0"
+__openapi_doc_version__: str = "0.0.3"
+__gen_version__: str = "2.496.0"
+__user_agent__: str = "speakeasy-sdk/python 0.21.0 2.496.0 0.0.3 plex-api-client"
 
 try:
     if __package__ is not None:

{plex_api_client-0.20.0 → plex_api_client-0.21.0}/src/plex_api_client/activities.py

@@ -43,7 +43,7 @@ class Activities(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
-        req = self.build_request(
+        req = self._build_request(
             method="GET",
             path="/activities",
             base_url=base_url,
@@ -100,7 +100,12 @@ class Activities(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.GetServerActivitiesUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = utils.stream_to_text(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -139,7 +144,7 @@ class Activities(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
-        req = self.build_request_async(
+        req = self._build_request_async(
             method="GET",
             path="/activities",
             base_url=base_url,
@@ -196,7 +201,12 @@ class Activities(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.GetServerActivitiesUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = await utils.stream_to_text_async(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -242,7 +252,7 @@ class Activities(BaseSDK):
             activity_uuid=activity_uuid,
         )
 
-        req = self.build_request(
+        req = self._build_request(
             method="DELETE",
             path="/activities/{activityUUID}",
             base_url=base_url,
@@ -296,7 +306,12 @@ class Activities(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.CancelServerActivitiesUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = utils.stream_to_text(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -342,7 +357,7 @@ class Activities(BaseSDK):
             activity_uuid=activity_uuid,
         )
 
-        req = self.build_request_async(
+        req = self._build_request_async(
             method="DELETE",
             path="/activities/{activityUUID}",
             base_url=base_url,
@@ -396,7 +411,12 @@ class Activities(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.CancelServerActivitiesUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = await utils.stream_to_text_async(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res

{plex_api_client-0.20.0 → plex_api_client-0.21.0}/src/plex_api_client/authentication.py

@@ -46,7 +46,7 @@ class Authentication(BaseSDK):
             scope=scope,
         )
 
-        req = self.build_request(
+        req = self._build_request(
             method="GET",
             path="/security/token",
             base_url=base_url,
@@ -100,7 +100,12 @@ class Authentication(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.GetTransientTokenUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = utils.stream_to_text(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -150,7 +155,7 @@ class Authentication(BaseSDK):
             scope=scope,
         )
 
-        req = self.build_request_async(
+        req = self._build_request_async(
             method="GET",
             path="/security/token",
             base_url=base_url,
@@ -204,7 +209,12 @@ class Authentication(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.GetTransientTokenUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = await utils.stream_to_text_async(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -252,7 +262,7 @@ class Authentication(BaseSDK):
             source=source,
         )
 
-        req = self.build_request(
+        req = self._build_request(
             method="GET",
             path="/security/resources",
             base_url=base_url,
@@ -306,7 +316,12 @@ class Authentication(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.GetSourceConnectionInformationUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = utils.stream_to_text(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -354,7 +369,7 @@ class Authentication(BaseSDK):
             source=source,
         )
 
-        req = self.build_request_async(
+        req = self._build_request_async(
             method="GET",
             path="/security/resources",
             base_url=base_url,
@@ -408,7 +423,12 @@ class Authentication(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.GetSourceConnectionInformationUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = await utils.stream_to_text_async(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -449,7 +469,7 @@ class Authentication(BaseSDK):
             base_url = server_url
         else:
             base_url = operations.GET_TOKEN_DETAILS_SERVERS[0]
-        req = self.build_request(
+        req = self._build_request(
             method="GET",
             path="/user",
             base_url=base_url,
@@ -506,7 +526,12 @@ class Authentication(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.GetTokenDetailsUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = utils.stream_to_text(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -547,7 +572,7 @@ class Authentication(BaseSDK):
             base_url = server_url
         else:
             base_url = operations.GET_TOKEN_DETAILS_SERVERS[0]
-        req = self.build_request_async(
+        req = self._build_request_async(
             method="GET",
             path="/user",
             base_url=base_url,
@@ -604,7 +629,12 @@ class Authentication(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.GetTokenDetailsUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = await utils.stream_to_text_async(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -655,7 +685,7 @@ class Authentication(BaseSDK):
             request = utils.unmarshal(request, operations.PostUsersSignInDataRequest)
         request = cast(operations.PostUsersSignInDataRequest, request)
 
-        req = self.build_request(
+        req = self._build_request(
             method="POST",
             path="/users/signin",
             base_url=base_url,
@@ -719,7 +749,12 @@ class Authentication(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.PostUsersSignInDataUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = utils.stream_to_text(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res
@@ -770,7 +805,7 @@ class Authentication(BaseSDK):
             request = utils.unmarshal(request, operations.PostUsersSignInDataRequest)
         request = cast(operations.PostUsersSignInDataRequest, request)
 
-        req = self.build_request_async(
+        req = self._build_request_async(
             method="POST",
             path="/users/signin",
             base_url=base_url,
@@ -834,7 +869,12 @@ class Authentication(BaseSDK):
             )
             data.raw_response = http_res
             raise errors.PostUsersSignInDataUnauthorized(data=data)
-        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.SDKError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
             http_res_text = await utils.stream_to_text_async(http_res)
             raise errors.SDKError(
                 "API error occurred", http_res.status_code, http_res_text, http_res

{plex_api_client-0.20.0 → plex_api_client-0.21.0}/src/plex_api_client/basesdk.py

@@ -20,7 +20,7 @@ class BaseSDK:
     def __init__(self, sdk_config: SDKConfiguration) -> None:
         self.sdk_configuration = sdk_config
 
-    def get_url(self, base_url, url_variables):
+    def _get_url(self, base_url, url_variables):
         sdk_url, sdk_variables = self.sdk_configuration.get_server_details()
 
         if base_url is None:
@@ -31,7 +31,7 @@ class BaseSDK:
 
         return utils.template_url(base_url, url_variables)
 
-    def build_request_async(
+    def _build_request_async(
         self,
         method,
         path,
@@ -53,7 +53,7 @@ class BaseSDK:
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> httpx.Request:
         client = self.sdk_configuration.async_client
-        return self.build_request_with_client(
+        return self._build_request_with_client(
             client,
             method,
             path,
@@ -73,7 +73,7 @@ class BaseSDK:
             http_headers,
         )
 
-    def build_request(
+    def _build_request(
         self,
         method,
         path,
@@ -95,7 +95,7 @@ class BaseSDK:
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> httpx.Request:
         client = self.sdk_configuration.client
-        return self.build_request_with_client(
+        return self._build_request_with_client(
             client,
             method,
             path,
@@ -115,7 +115,7 @@ class BaseSDK:
             http_headers,
         )
 
-    def build_request_with_client(
+    def _build_request_with_client(
         self,
         client,
         method,
@@ -142,7 +142,7 @@ class BaseSDK:
         url = url_override
         if url is None:
             url = utils.generate_url(
-                self.get_url(base_url, url_variables),
+                self._get_url(base_url, url_variables),
                 path,
                 request if request_has_path_params else None,
                 _globals if request_has_path_params else None,