aioaudiobookshelf 0.1.4__tar.gz → 0.1.5__tar.gz

{aioaudiobookshelf-0.1.4 → aioaudiobookshelf-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: aioaudiobookshelf
-Version: 0.1.4
+Version: 0.1.5
 Summary: Async library for Audiobookshelf
 Author-email: Fabian Munkes <105975993+fmunkes@users.noreply.github.com>
 License: Apache-2.0
@@ -109,7 +109,7 @@ async def abs_basics():
 
         # get a single podcast
         podcast_id = "dda96167-eaad-4012-83e1-149c6700d3e8"
-        podcast_expanded = client.get_library_item_podcast(podcast_id=podcast_id, expanded=True)
+        podcast_expanded = await client.get_library_item_podcast(podcast_id=podcast_id, expanded=True)
 
 
 asyncio.run(abs_basics())

{aioaudiobookshelf-0.1.4 → aioaudiobookshelf-0.1.5}/README.md

@@ -79,7 +79,7 @@ async def abs_basics():
 
         # get a single podcast
         podcast_id = "dda96167-eaad-4012-83e1-149c6700d3e8"
-        podcast_expanded = client.get_library_item_podcast(podcast_id=podcast_id, expanded=True)
+        podcast_expanded = await client.get_library_item_podcast(podcast_id=podcast_id, expanded=True)
 
 
 asyncio.run(abs_basics())

{aioaudiobookshelf-0.1.4 → aioaudiobookshelf-0.1.5}/aioaudiobookshelf/__init__.py

@@ -6,7 +6,7 @@ from aioaudiobookshelf.client import AdminClient, SessionConfiguration, SocketCl
 from aioaudiobookshelf.exceptions import LoginError, TokenIsMissingError
 from aioaudiobookshelf.schema.calls_login import AuthorizeResponse, LoginParameters, LoginResponse
 
-__version__ = "0.1.4"
+__version__ = "0.1.5"
 
 
 async def _get_login_response(

{aioaudiobookshelf-0.1.4 → aioaudiobookshelf-0.1.5}/aioaudiobookshelf/client/_base.py

@@ -32,9 +32,8 @@ class BaseClient:
             self.logger = self.session_config.logger
 
         self.logger.debug(
-            "Initialized client %s, token: %s",
+            "Initialized client %s",
             self.__class__.__name__,
-            self._token,
         )
 
         self._verify_user()

{aioaudiobookshelf-0.1.4 → aioaudiobookshelf-0.1.5}/aioaudiobookshelf/client/libraries.py

@@ -3,6 +3,7 @@
 from collections.abc import AsyncGenerator
 from typing import TypeVar
 
+from mashumaro.codecs.json import json_decode
 from mashumaro.mixins.json import DataClassJSONMixin
 
 from aioaudiobookshelf.client._base import BaseClient
@@ -18,6 +19,7 @@ from aioaudiobookshelf.schema.calls_library import (
     LibraryWithFilterDataResponse,
 )
 from aioaudiobookshelf.schema.library import Library, LibraryFilterData
+from aioaudiobookshelf.schema.shelf import Shelf
 
 ResponseMinified = TypeVar("ResponseMinified", bound=DataClassJSONMixin)
 ResponseNormal = TypeVar("ResponseNormal", bound=DataClassJSONMixin)
@@ -147,7 +149,17 @@ class LibrariesClient(BaseClient):
         ):
             yield result
 
-    # get library's personalized view
+    async def get_library_personalized_view(
+        self, *, library_id: str, limit: int = 10
+    ) -> list[Shelf]:
+        """Get personalized view of library.
+
+        TODO: Add rssfeed
+        """
+        response = await self._get(
+            endpoint=f"/api/libraries/{library_id}/personalized", params={"limit": limit}
+        )
+        return json_decode(response, list[Shelf])
 
     async def get_library_filterdata(self, *, library_id: str) -> LibraryFilterData:
         """Get filterdata of library."""

aioaudiobookshelf-0.1.5/aioaudiobookshelf/schema/shelf.py

@@ -0,0 +1,188 @@
+"""Schema for shelf, the response object to library's personalized view."""
+# Discriminators don't work together with aliases.
+# https://github.com/Fatal1ty/mashumaro/issues/254
+# ruff: noqa: N815
+
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import Annotated
+
+from mashumaro.types import Alias, Discriminator
+
+from aioaudiobookshelf.schema.author import AuthorExpanded
+from aioaudiobookshelf.schema.book import BookMinified
+
+from . import _BaseModel
+from .library import LibraryMediaType, _LibraryItemBase
+from .podcast import PodcastEpisode, PodcastMinified
+from .series import Series
+
+
+class ShelfId(StrEnum):
+    """ShelfId."""
+
+    LISTEN_AGAIN = "listen-again"
+    CONTINUE_LISTENING = "continue-listening"
+    CONTINUE_SERIES = "continue-series"
+    RECOMMENDED = "recommended"
+    RECENTLY_ADDED = "recently-added"
+    EPISODES_RECENTLY_ADDED = "episodes-recently-added"
+    RECENT_SERIES = "recent-series"
+    NEWEST_AUTHORS = "newest-authors"
+    NEWEST_EPISODES = "newest-episodes"
+    DISCOVER = "discover"
+
+
+@dataclass(kw_only=True)
+class ShelfLibraryItemMinified(_LibraryItemBase):
+    """ShelfLibraryItemMinified.
+
+    Beside using type, there is another distinction on which attributes
+    are available based on the id. We allow ourselves the easy route
+    here, and just make all of them optional.
+    """
+
+    # episode (type) and
+    # id: continue-listening, listen-again, episodes-recently-added
+    recent_episode: Annotated[PodcastEpisode | None, Alias("recentEpisode")] = None
+
+    # id: continue-listening
+    progress_last_update_ms: Annotated[int | None, Alias("progressLastUpdate")] = None
+
+    # id: continue-series
+    previous_book_in_progress_last_update_ms: Annotated[
+        int | None, Alias("prevBookInProgressLastUpdate")
+    ] = None
+    # TODO: minified item has seriesSequence, which we currently ignore
+
+    # id: recommended
+    weight: float | None = None
+
+    # id: listen-again
+    finished_at_ms: Annotated[int | None, Alias("finishedAt")] = None
+
+    # This and the two subclasses are copied over from libraries, as we otherwise
+    # face issues with the discriminator
+    class Config(_LibraryItemBase.Config):
+        """Config."""
+
+        discriminator = Discriminator(
+            field="mediaType",
+            include_subtypes=True,
+        )
+
+    num_files: Annotated[int, Alias("numFiles")]
+    size: int
+
+
+@dataclass(kw_only=True)
+class LibraryItemMinifiedBook(ShelfLibraryItemMinified):
+    """LibraryItemMinifiedBook."""
+
+    media: BookMinified
+    mediaType: LibraryMediaType = LibraryMediaType.BOOK
+
+
+@dataclass(kw_only=True)
+class LibraryItemMinifiedPodcast(ShelfLibraryItemMinified):
+    """LibraryItemMinifiedPodcast."""
+
+    media: PodcastMinified
+    mediaType: LibraryMediaType = LibraryMediaType.PODCAST
+
+
+@dataclass(kw_only=True)
+class LibraryItemMinifiedBookSeriesShelf(ShelfLibraryItemMinified):
+    """LibraryItemMinifiedBookSeriesShelf."""
+
+    # this appears not to be around?
+    series_sequence: Annotated[str | int | None, Alias("seriesSequence")] = None
+
+
+@dataclass(kw_only=True)
+class SeriesShelf(Series):
+    """SeriesShelf."""
+
+    books: list[LibraryItemMinifiedBookSeriesShelf]
+    in_progress: Annotated[bool | None, Alias("inProgress")] = None
+    has_active_book: Annotated[bool | None, Alias("hasActiveBook")] = None
+    hide_from_continue_listening: Annotated[bool | None, Alias("hideFromContinueListening")] = None
+    book_in_progress_last_update_ms: Annotated[int | None, Alias("bookInProgressLastUpdate")] = None
+    first_book_unread: Annotated[
+        LibraryItemMinifiedBookSeriesShelf | None, Alias("firstBookUnread")
+    ] = None
+
+
+class ShelfType(StrEnum):
+    """ShelfType."""
+
+    BOOK = "book"
+    SERIES = "series"
+    AUTHORS = "authors"
+    EPISODE = "episode"
+    PODCAST = "podcast"
+
+
+@dataclass(kw_only=True)
+class _ShelfBase(_BaseModel):
+    """Shelf."""
+
+    id_: Annotated[ShelfId | str, Alias("id")]
+    label: str
+    label_string_key: Annotated[str, Alias("labelStringKey")]
+    type_: Annotated[ShelfType, Alias("type")]
+    category: str | None = None
+
+
+@dataclass(kw_only=True)
+class Shelf(_ShelfBase):
+    """Shelf."""
+
+    class Config(_ShelfBase.Config):
+        """Config."""
+
+        discriminator = Discriminator(
+            field="type",
+            include_subtypes=True,
+        )
+
+
+@dataclass(kw_only=True)
+class ShelfBook(Shelf):
+    """ShelfBook."""
+
+    type = ShelfType.BOOK
+    entities: list[ShelfLibraryItemMinified]
+
+
+@dataclass(kw_only=True)
+class ShelfPodcast(Shelf):
+    """ShelfBook."""
+
+    type = ShelfType.PODCAST
+    entities: list[ShelfLibraryItemMinified]
+
+
+@dataclass(kw_only=True)
+class ShelfEpisode(Shelf):
+    """ShelfBook."""
+
+    type = ShelfType.EPISODE
+    entities: list[ShelfLibraryItemMinified]
+
+
+@dataclass(kw_only=True)
+class ShelfAuthors(Shelf):
+    """ShelfAuthor."""
+
+    type = ShelfType.AUTHORS
+
+    entities: list[AuthorExpanded]
+
+
+@dataclass(kw_only=True)
+class ShelfSeries(Shelf):
+    """ShelfSeries."""
+
+    type = ShelfType.SERIES
+    entities: list[SeriesShelf]

{aioaudiobookshelf-0.1.4 → aioaudiobookshelf-0.1.5}/aioaudiobookshelf.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: aioaudiobookshelf
-Version: 0.1.4
+Version: 0.1.5
 Summary: Async library for Audiobookshelf
 Author-email: Fabian Munkes <105975993+fmunkes@users.noreply.github.com>
 License: Apache-2.0
@@ -109,7 +109,7 @@ async def abs_basics():
 
         # get a single podcast
         podcast_id = "dda96167-eaad-4012-83e1-149c6700d3e8"
-        podcast_expanded = client.get_library_item_podcast(podcast_id=podcast_id, expanded=True)
+        podcast_expanded = await client.get_library_item_podcast(podcast_id=podcast_id, expanded=True)
 
 
 asyncio.run(abs_basics())

{aioaudiobookshelf-0.1.4 → aioaudiobookshelf-0.1.5}/aioaudiobookshelf.egg-info/SOURCES.txt

@@ -46,4 +46,5 @@ aioaudiobookshelf/schema/series.py
 aioaudiobookshelf/schema/series_books.py
 aioaudiobookshelf/schema/server.py
 aioaudiobookshelf/schema/session.py
+aioaudiobookshelf/schema/shelf.py
 aioaudiobookshelf/schema/user.py

{aioaudiobookshelf-0.1.4 → aioaudiobookshelf-0.1.5}/pyproject.toml

@@ -18,7 +18,7 @@ description = "Async library for Audiobookshelf"
 license = {text = "Apache-2.0"}
 readme = "README.md"
 requires-python = ">=3.12"
-version = "0.1.4"
+version = "0.1.5"
 
 [project.optional-dependencies]
 test = [
@@ -133,7 +133,7 @@ known-first-party = ["music_assistant"]
 max-complexity = 25
 
 [tool.bumpver]
-current_version = "0.1.4"
+current_version = "0.1.5"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"