aioaudiobookshelf 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

aioaudiobookshelf/__init__.py

@@ -3,15 +3,16 @@
 from aiohttp.client_exceptions import ClientResponseError, InvalidUrlClientError
 
 from aioaudiobookshelf.client import AdminClient, SessionConfiguration, SocketClient, UserClient
-from aioaudiobookshelf.exceptions import LoginError
-from aioaudiobookshelf.schema.calls_login import LoginParameters, LoginResponse
+from aioaudiobookshelf.exceptions import LoginError, TokenIsMissingError
+from aioaudiobookshelf.schema.calls_login import AuthorizeResponse, LoginParameters, LoginResponse
 
-__version__ = "0.1.1"
+__version__ = "0.1.3"
 
 
 async def _get_login_response(
     *, session_config: SessionConfiguration, username: str, password: str
 ) -> LoginResponse:
+    """Login via username and password."""
     login_request = LoginParameters(username=username, password=password).to_dict()
 
     try:
@@ -26,6 +27,42 @@ async def _get_login_response(
     return LoginResponse.from_json(await resp.read())
 
 
+async def _get_authorize_response(*, session_config: SessionConfiguration) -> AuthorizeResponse:
+    """Login via token."""
+    try:
+        resp = await session_config.session.post(
+            f"{session_config.url}/api/authorize",
+            ssl=session_config.verify_ssl,
+            raise_for_status=True,
+            headers=session_config.headers,
+        )
+    except (ClientResponseError, InvalidUrlClientError, TokenIsMissingError) as exc:
+        raise LoginError from exc
+    return AuthorizeResponse.from_json(await resp.read())
+
+
+async def get_user_client_by_token(*, session_config: SessionConfiguration) -> UserClient:
+    """Get user client by token. Token must be set in session_config."""
+    authorize_response = await _get_authorize_response(session_config=session_config)
+    return UserClient(session_config=session_config, login_response=authorize_response)
+
+
+async def get_user_and_socket_client_by_token(
+    *, session_config: SessionConfiguration
+) -> tuple[UserClient, SocketClient]:
+    """Get user and socket client by token. Token must be set in session_config."""
+    authorize_response = await _get_authorize_response(session_config=session_config)
+    user_client = UserClient(session_config=session_config, login_response=authorize_response)
+    socket_client = SocketClient(session_config=session_config)
+    return user_client, socket_client
+
+
+async def get_admin_client_by_token(*, session_config: SessionConfiguration) -> AdminClient:
+    """Get admin client by token. Token must be set in session_config."""
+    authorize_response = await _get_authorize_response(session_config=session_config)
+    return AdminClient(session_config=session_config, login_response=authorize_response)
+
+
 async def get_user_client(
     *,
     session_config: SessionConfiguration,

aioaudiobookshelf/client/__init__.py

@@ -9,7 +9,7 @@ import socketio
 import socketio.exceptions
 from aiohttp import ClientSession
 
-from aioaudiobookshelf.exceptions import BadUserError
+from aioaudiobookshelf.exceptions import BadUserError, TokenIsMissingError
 from aioaudiobookshelf.schema.events_socket import (
     LibraryItemRemoved,
     PodcastEpisodeDownload,
@@ -37,7 +37,7 @@ class SessionConfiguration:
     session: ClientSession
     url: str
     verify_ssl: bool = True
-    token: str = ""
+    token: str | None = None
     pagination_items_per_page: int = 10
     logger: logging.Logger | None = None
 
@@ -45,7 +45,7 @@ class SessionConfiguration:
     def headers(self) -> dict[str, str]:
         """Session headers."""
         if self.token is None:
-            raise RuntimeError("Token not set.")
+            raise TokenIsMissingError("Token not set.")
         return {"Authorization": f"Bearer {self.token}"}
 
     def __post_init__(self) -> None:

aioaudiobookshelf/client/_base.py

@@ -97,7 +97,7 @@ class BaseClient:
         """DELETE request to abs api."""
         try:
             await self.session_config.session.delete(
-                endpoint,
+                f"{self.session_config.url}/{endpoint}",
                 ssl=self.session_config.verify_ssl,
                 headers=self.session_config.headers,
                 raise_for_status=True,

aioaudiobookshelf/exceptions.py

@@ -11,3 +11,7 @@ class LoginError(Exception):
 
 class ApiError(Exception):
     """Exception raised if call to api failed."""
+
+
+class TokenIsMissingError(Exception):
+    """Exception raised if token is missing."""

aioaudiobookshelf/schema/calls_login.py

@@ -26,3 +26,7 @@ class LoginResponse(DataClassJSONMixin):
     user_default_library_id: Annotated[str, Alias("userDefaultLibraryId")]
     server_settings: Annotated[ServerSettings, Alias("serverSettings")]
     source: Annotated[str, Alias("Source")]
+
+
+# api/authorize, if token is used for authorization
+AuthorizeResponse = LoginResponse

aioaudiobookshelf-0.1.3.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.2
+Name: aioaudiobookshelf
+Version: 0.1.3
+Summary: Async library for Audiobookshelf
+Author-email: Fabian Munkes <105975993+fmunkes@users.noreply.github.com>
+License: Apache-2.0
+Platform: any
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp
+Requires-Dist: mashumaro
+Requires-Dist: python-socketio>=5.12
+Provides-Extra: test
+Requires-Dist: codespell==2.3.0; extra == "test"
+Requires-Dist: isort==5.13.2; extra == "test"
+Requires-Dist: mypy==1.13.0; extra == "test"
+Requires-Dist: pre-commit==4.0.1; extra == "test"
+Requires-Dist: pre-commit-hooks==5.0.0; extra == "test"
+Requires-Dist: pytest==8.3.4; extra == "test"
+Requires-Dist: pytest-aiohttp==1.0.5; extra == "test"
+Requires-Dist: pytest-cov==5.0.0; extra == "test"
+Requires-Dist: syrupy==4.8.1; extra == "test"
+Requires-Dist: tomli==2.2.1; extra == "test"
+Requires-Dist: ruff==0.9.2; extra == "test"
+Requires-Dist: bumpver; extra == "test"
+
+# aioaudiobookshelf
+Async python library to interact with
+[Audiobookshelf](https://github.com/advplyr/audiobookshelf) (ABS).
+
+This lib's primary goal is to be used within the Audiobookshelf music provider
+in Music Assistant, but it can be used independently. Calls to endpoints not
+needed for the provider will be added over time.
+
+Not all endpoints are yet implemented.
+
+## Releases
+Releases can be found on [pypi](https://pypi.org/project/aioaudiobookshelf/),
+and are tagged.
+
+## Basic usage
+ABS has a rest api, documented
+[here](https://api.audiobookshelf.org) and additionally uses socket.io, see
+[here](https://api.audiobookshelf.org/#socket) for some event driven
+functionality.
+Accessibility to the endpoints is determined by the [user
+types](https://api.audiobookshelf.org/#user), which may be `root, admin, user, guest`.
+This lib is not tested with a `guest` user.
+
+As of `0.1.2` this lib has two different clients, the `UserClient` and the
+`SocketClient`. Admin endpoints are not yet implemented. The user client
+handles calls to the Rest API, the socket client allows to subscribe to certain
+events.
+
+To authenticate the socket client, you always need the user's token, username
+and password are not enough. The user client can be authenticated by username
+and password, which yields the token.
+
+Usage example:
+```python
+import asyncio
+import logging
+import os
+
+import aiohttp
+
+from aioaudiobookshelf import SessionConfiguration, get_user_client
+from aioaudiobookshelf.schema.library import LibraryItemMinifiedBook, LibraryItemMinifiedPodcast
+
+ABS_HOST = os.environ.get("ABS_HOST")
+ABS_USER = os.environ.get("ABS_USER")
+ABS_PASSWORD = os.environ.get("ABS_PASSWORD")
+
+
+async def abs_basics():
+    assert ABS_HOST is not None
+    assert ABS_USER is not None
+    assert ABS_PASSWORD is not None
+
+    logger = logging.getLogger()
+    logger.setLevel(logging.INFO)
+
+    async with aiohttp.ClientSession() as session:
+        client = await get_user_client(
+            session_config=SessionConfiguration(
+                session=session, url=ABS_HOST, logger=logger, pagination_items_per_page=30
+            ),
+            username=ABS_USER,
+            password=ABS_PASSWORD,
+        )
+
+        # get libraries
+        libraries = await client.get_all_libraries()
+
+        # get library items
+        for library in libraries:
+            async for response in client.get_library_items(library_id=library.id_):
+                if not response.results:
+                    break
+                for lib_item_minified in response.results:
+                    if isinstance(lib_item_minified, LibraryItemMinifiedPodcast):
+                        ...
+                    if isinstance(lib_item_minified, LibraryItemMinifiedBook):
+                        ...
+
+        # get a single podcast
+        podcast_id = "dda96167-eaad-4012-83e1-149c6700d3e8"
+        podcast_expanded = client.get_library_item_podcast(podcast_id=podcast_id, expanded=True)
+
+
+asyncio.run(abs_basics())
+```
+
+Have a look into `aioaudiobookshelf/client/*.py` to see which endpoints are
+currently implemented. And the [provider
+implementation](https://github.com/music-assistant/server/blob/dev/music_assistant/providers/audiobookshelf/__init__.py) shows, how the lib can potentially be used.

{aioaudiobookshelf-0.1.1.dist-info → aioaudiobookshelf-0.1.3.dist-info}/RECORD

@@ -1,8 +1,8 @@
-aioaudiobookshelf/__init__.py,sha256=IAfzHf7g91fL00jEwYQU9Qww11y6ZuSfZgw_aRz3WMY,2328
-aioaudiobookshelf/exceptions.py,sha256=_RtQE75rMnMkEfHxHN0D1N1pcEOLiGI1-Ajjdix1flk,289
+aioaudiobookshelf/__init__.py,sha256=0EEeNclXbVxB0ihoNGvWevaWt-SpLj3okzHDIVCR0mU,4138
+aioaudiobookshelf/exceptions.py,sha256=JQNdqBaR5AhuCUBg5DH5-orkfJrx_CJpe53ignWD6vE,377
 aioaudiobookshelf/helpers.py,sha256=ImZntca2l39P285TVVrFah82MjrP4wXLnVd7LMoD5Ck,1581
-aioaudiobookshelf/client/__init__.py,sha256=wQ7AB-Ly3G6hGNtU0Fg9bnYPtyZiznNe1Ubwdwm1H88,6894
-aioaudiobookshelf/client/_base.py,sha256=edEkmSrzSFcq38DQMYHLkWeOp6yCYSdDA3WGO9lyyxg,3784
+aioaudiobookshelf/client/__init__.py,sha256=YnrNm2ZmQeVqGQ8EfAKIPRI4p2cLFqCzv4uKgL6HJPM,6931
+aioaudiobookshelf/client/_base.py,sha256=1S0ACN-fiXKy0uVVLb422LGFB4bOvVFnSvyEDM47-v0,3815
 aioaudiobookshelf/client/authors.py,sha256=8bXN0NsPvH1rvF166xUu7rVC-0P0Sp4N7oxZrO666nc,1129
 aioaudiobookshelf/client/collections_.py,sha256=Z3r7dxHhzMm_cGCMRJkVzN5-Eesftib3d0bs4iXmmzY,879
 aioaudiobookshelf/client/items.py,sha256=4yWy7Shd6sbKj4MSGYJXklXs-yZH2q95qGIm4L-PS5o,3624
@@ -20,7 +20,7 @@ aioaudiobookshelf/schema/calls_authors.py,sha256=eIvdyEcrmXuOxFJuCX39cGU9HSZprl4
 aioaudiobookshelf/schema/calls_collections.py,sha256=nXurha41Y1atAuOWG9aXJbYo66qgcFUaW02QPEVdo4w,319
 aioaudiobookshelf/schema/calls_items.py,sha256=KF8s6WNbsVUIxAuN9TZBBGsysnxfw-FQWM9XRTljOpo,1547
 aioaudiobookshelf/schema/calls_library.py,sha256=IX4vf55fUW5wLADo1QnCIg3tEhtQ2UuyKsZWpx5CmtU,2543
-aioaudiobookshelf/schema/calls_login.py,sha256=36HeRkoIyTLQbsSMxVq1PiE0iLnR48VsOfKsc_VDI6E,703
+aioaudiobookshelf/schema/calls_login.py,sha256=squLCKxXHRxzlm4-1BOCDQ5-Zics1717JuZ89STkN5g,791
 aioaudiobookshelf/schema/calls_me.py,sha256=jdpvExRytoqX8FHkzq4N9RtKn50cmTc_B693e9lLCHQ,693
 aioaudiobookshelf/schema/calls_playlists.py,sha256=Ll1scstd1NNc6PXgkhmWUfqSzIR07LKzqBCEvrVHACE,305
 aioaudiobookshelf/schema/calls_series.py,sha256=aUdlTR01UE2APN0pGS1h7x0ydsREqZf53mKaHq2zeh4,597
@@ -38,8 +38,8 @@ aioaudiobookshelf/schema/series_books.py,sha256=rs8a4JmSHqJR6WPA2XKXmC6XDq8D9wmz
 aioaudiobookshelf/schema/server.py,sha256=yWBRxtwtX1USs43yGFuDIM3jfWbmduW3GRahisOUCqw,2726
 aioaudiobookshelf/schema/session.py,sha256=jqCHNUthuzE6jhgG3UwFgagl1HA_rfDwn6Te38jaqC8,2684
 aioaudiobookshelf/schema/user.py,sha256=Zcnl6gqfc97dmHrNOHVsX_OOqwcJq-eFMhc9zVMLIs4,2057
-aioaudiobookshelf-0.1.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-aioaudiobookshelf-0.1.1.dist-info/METADATA,sha256=qY_lHwOyIzg-fG_HSU4eHKYirUlrP4M5D47U-P68BOA,1184
-aioaudiobookshelf-0.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-aioaudiobookshelf-0.1.1.dist-info/top_level.txt,sha256=2_I2_xz98xmVIT84pcF3tlq3NdZNKskfs7BqUmYZylk,18
-aioaudiobookshelf-0.1.1.dist-info/RECORD,,
+aioaudiobookshelf-0.1.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+aioaudiobookshelf-0.1.3.dist-info/METADATA,sha256=ljk8u6oZQb4vvS8meJbMlxxC_HrT0rfs9GCzzJzntOE,4377
+aioaudiobookshelf-0.1.3.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+aioaudiobookshelf-0.1.3.dist-info/top_level.txt,sha256=2_I2_xz98xmVIT84pcF3tlq3NdZNKskfs7BqUmYZylk,18
+aioaudiobookshelf-0.1.3.dist-info/RECORD,,

{aioaudiobookshelf-0.1.1.dist-info → aioaudiobookshelf-0.1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

aioaudiobookshelf-0.1.1.dist-info/METADATA

@@ -1,32 +0,0 @@
-Metadata-Version: 2.2
-Name: aioaudiobookshelf
-Version: 0.1.1
-Summary: Async library for Audiobookshelf
-Author-email: Fabian Munkes <105975993+fmunkes@users.noreply.github.com>
-License: Apache-2.0
-Platform: any
-Classifier: Environment :: Console
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: aiohttp
-Requires-Dist: mashumaro
-Requires-Dist: python-socketio>=5.12
-Provides-Extra: test
-Requires-Dist: codespell==2.3.0; extra == "test"
-Requires-Dist: isort==5.13.2; extra == "test"
-Requires-Dist: mypy==1.13.0; extra == "test"
-Requires-Dist: pre-commit==4.0.1; extra == "test"
-Requires-Dist: pre-commit-hooks==5.0.0; extra == "test"
-Requires-Dist: pytest==8.3.4; extra == "test"
-Requires-Dist: pytest-aiohttp==1.0.5; extra == "test"
-Requires-Dist: pytest-cov==5.0.0; extra == "test"
-Requires-Dist: syrupy==4.8.1; extra == "test"
-Requires-Dist: tomli==2.2.1; extra == "test"
-Requires-Dist: ruff==0.9.2; extra == "test"
-Requires-Dist: bumpver; extra == "test"
-
-# aioaudiobookshelf
-Async python library to interact with Audiobookshelf