Profile Service

The SkoobProfileService lets you modify your Skoob profile by labeling, shelving and rating books.

Example

import os
from pyskoob import SkoobClient
from pyskoob.models.enums import BookStatus

with SkoobClient() as client:
    client.auth.login(
        email=os.getenv("SKOOB_EMAIL"),
        password=os.getenv("SKOOB_PASSWORD"),
    )
    client.profile.update_book_status(10, BookStatus.READ)

Profile management helpers for authenticated Skoob users.

`AsyncSkoobProfileService`

Bases: _ProfileServiceMixin, AsyncAuthenticatedService

Asynchronous variant of :class:SkoobProfileService.

Source code in pyskoob/profile.py

class AsyncSkoobProfileService(_ProfileServiceMixin, AsyncAuthenticatedService):  # pragma: no cover - thin async wrapper
    """Asynchronous variant of :class:`SkoobProfileService`."""

    def __init__(self, client: AsyncHTTPClient, auth_service: AsyncAuthService):
        super().__init__(client, auth_service)

    async def add_book_label(self, edition_id: int, label: BookLabel) -> bool:
        """Add a label to a book in the authenticated profile.

        Parameters
        ----------
        edition_id : int
            Edition identifier of the book.
        label : BookLabel
            Label to associate with the book.

        Returns
        -------
        bool
            ``True`` if the label was added successfully.
        """

        return await self._add_book_label(edition_id, label)

    async def remove_book_label(self, edition_id: int) -> bool:
        """Remove a label from a book in the authenticated profile.

        Parameters
        ----------
        edition_id : int
            Edition identifier of the book.

        Returns
        -------
        bool
            ``True`` if the label was removed successfully.
        """

        return await self._remove_book_label(edition_id)

    async def update_book_status(self, edition_id: int, status: BookStatus) -> bool:
        """Update the user's status for a book.

        Parameters
        ----------
        edition_id : int
            Edition identifier of the book.
        status : BookStatus
            New status to assign to the book.

        Returns
        -------
        bool
            ``True`` if the status was updated successfully.
        """

        return await self._update_book_status(edition_id, status)

    async def remove_book_status(self, edition_id: int) -> bool:
        """Remove the user's status for a book.

        Parameters
        ----------
        edition_id : int
            Edition identifier of the book.

        Returns
        -------
        bool
            ``True`` if the status was removed successfully.
        """

        return await self._remove_book_status(edition_id)

    async def change_book_shelf(self, edition_id: int, bookshelf: BookShelf) -> bool:
        """Move a book to a different bookshelf.

        Parameters
        ----------
        edition_id : int
            Edition identifier of the book.
        bookshelf : BookShelf
            Destination bookshelf.

        Returns
        -------
        bool
            ``True`` if the book was moved successfully.
        """

        return await self._change_book_shelf(edition_id, bookshelf)

    async def rate_book(self, edition_id: int, rating: float) -> bool:
        """Rate a book in the authenticated profile.

        Parameters
        ----------
        edition_id : int
            Edition identifier of the book.
        rating : float
            Rating between ``0`` and ``5``.

        Returns
        -------
        bool
            ``True`` if the rating was stored successfully.
        """

        return await self._rate_book(edition_id, rating)

`add_book_label(edition_id, label)` `async`

Add a label to a book in the authenticated profile.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	Edition identifier of the book.	required
`label`	`BookLabel`	Label to associate with the book.	required

Returns:

Type	Description
`bool`	`True` if the label was added successfully.

Source code in pyskoob/profile.py

async def add_book_label(self, edition_id: int, label: BookLabel) -> bool:
    """Add a label to a book in the authenticated profile.

    Parameters
    ----------
    edition_id : int
        Edition identifier of the book.
    label : BookLabel
        Label to associate with the book.

    Returns
    -------
    bool
        ``True`` if the label was added successfully.
    """

    return await self._add_book_label(edition_id, label)

`change_book_shelf(edition_id, bookshelf)` `async`

Move a book to a different bookshelf.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	Edition identifier of the book.	required
`bookshelf`	`BookShelf`	Destination bookshelf.	required

Returns:

Type	Description
`bool`	`True` if the book was moved successfully.

Source code in pyskoob/profile.py

async def change_book_shelf(self, edition_id: int, bookshelf: BookShelf) -> bool:
    """Move a book to a different bookshelf.

    Parameters
    ----------
    edition_id : int
        Edition identifier of the book.
    bookshelf : BookShelf
        Destination bookshelf.

    Returns
    -------
    bool
        ``True`` if the book was moved successfully.
    """

    return await self._change_book_shelf(edition_id, bookshelf)

`rate_book(edition_id, rating)` `async`

Rate a book in the authenticated profile.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	Edition identifier of the book.	required
`rating`	`float`	Rating between `0` and `5`.	required

Returns:

Type	Description
`bool`	`True` if the rating was stored successfully.

Source code in pyskoob/profile.py

async def rate_book(self, edition_id: int, rating: float) -> bool:
    """Rate a book in the authenticated profile.

    Parameters
    ----------
    edition_id : int
        Edition identifier of the book.
    rating : float
        Rating between ``0`` and ``5``.

    Returns
    -------
    bool
        ``True`` if the rating was stored successfully.
    """

    return await self._rate_book(edition_id, rating)

`remove_book_label(edition_id)` `async`

Remove a label from a book in the authenticated profile.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	Edition identifier of the book.	required

Returns:

Type	Description
`bool`	`True` if the label was removed successfully.

Source code in pyskoob/profile.py

async def remove_book_label(self, edition_id: int) -> bool:
    """Remove a label from a book in the authenticated profile.

    Parameters
    ----------
    edition_id : int
        Edition identifier of the book.

    Returns
    -------
    bool
        ``True`` if the label was removed successfully.
    """

    return await self._remove_book_label(edition_id)

`remove_book_status(edition_id)` `async`

Remove the user's status for a book.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	Edition identifier of the book.	required

Returns:

Type	Description
`bool`	`True` if the status was removed successfully.

Source code in pyskoob/profile.py

async def remove_book_status(self, edition_id: int) -> bool:
    """Remove the user's status for a book.

    Parameters
    ----------
    edition_id : int
        Edition identifier of the book.

    Returns
    -------
    bool
        ``True`` if the status was removed successfully.
    """

    return await self._remove_book_status(edition_id)

`update_book_status(edition_id, status)` `async`

Update the user's status for a book.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	Edition identifier of the book.	required
`status`	`BookStatus`	New status to assign to the book.	required

Returns:

Type	Description
`bool`	`True` if the status was updated successfully.

Source code in pyskoob/profile.py

async def update_book_status(self, edition_id: int, status: BookStatus) -> bool:
    """Update the user's status for a book.

    Parameters
    ----------
    edition_id : int
        Edition identifier of the book.
    status : BookStatus
        New status to assign to the book.

    Returns
    -------
    bool
        ``True`` if the status was updated successfully.
    """

    return await self._update_book_status(edition_id, status)

`SkoobProfileService`

Bases: _ProfileServiceMixin, AuthenticatedService

Perform profile-related actions such as labeling and rating books.

Source code in pyskoob/profile.py

class SkoobProfileService(_ProfileServiceMixin, AuthenticatedService):
    """Perform profile-related actions such as labeling and rating books."""

    def __init__(self, client: SyncHTTPClient, auth_service: AuthService):
        """Initialize the service with dependencies.

        This service requires an authenticated session via
        :class:`AuthService` and is typically used alongside
        :class:`UserService` when manipulating the logged user's bookshelf
        and other profile metadata.

        Parameters
        ----------
        client : SyncHTTPClient
            The HTTP client to use for requests.
        auth_service : AuthService
            The authentication service.
        """
        super().__init__(client, auth_service)

    def add_book_label(self, edition_id: int, label: BookLabel) -> bool:
        """
        Adds a label to a book.

        Parameters
        ----------
        edition_id : int
            The edition ID of the book.
        label : BookLabel
            The label to add.

        Returns
        -------
        bool
            True if the label was added successfully, False otherwise.

        Examples
        --------
        >>> service.add_book_label(10, BookLabel.FAVORITE)
        True
        """
        return run_sync(self._add_book_label(edition_id, label))

    def remove_book_label(self, edition_id: int) -> bool:
        """
        Removes a label from a book.

        Parameters
        ----------
        edition_id : int
            The edition ID of the book.

        Returns
        -------
        bool
            True if the label was removed successfully, False otherwise.

        Examples
        --------
        >>> service.remove_book_label(10)
        True
        """
        return run_sync(self._remove_book_label(edition_id))

    def update_book_status(self, edition_id: int, status: BookStatus) -> bool:
        """
        Updates the status of a book.

        Parameters
        ----------
        edition_id : int
            The edition ID of the book.
        status : BookStatus
            The new status for the book.

        Returns
        -------
        bool
            True if the status was updated successfully, False otherwise.

        Examples
        --------
        >>> service.update_book_status(10, BookStatus.READ)
        True
        """
        return run_sync(self._update_book_status(edition_id, status))

    def remove_book_status(self, edition_id: int) -> bool:
        """
        Removes the status of a book.

        Parameters
        ----------
        edition_id : int
            The edition ID of the book.

        Returns
        -------
        bool
            True if the status was removed successfully, False otherwise.

        Examples
        --------
        >>> service.remove_book_status(10)
        True
        """
        return run_sync(self._remove_book_status(edition_id))

    def change_book_shelf(self, edition_id: int, bookshelf: BookShelf) -> bool:
        """
        Changes the bookshelf of a book.

        Parameters
        ----------
        edition_id : int
            The edition ID of the book.
        bookshelf : BookShelf
            The new bookshelf for the book.

        Returns
        -------
        bool
            True if the bookshelf was changed successfully, False otherwise.

        Examples
        --------
        >>> service.change_book_shelf(10, BookShelf.BOOK)
        True
        """
        return run_sync(self._change_book_shelf(edition_id, bookshelf))

    def rate_book(self, edition_id: int, rating: float) -> bool:
        """Rates a book.

        Parameters
        ----------
        edition_id : int
            The edition ID of the book.
        rating : float
            The rating to give to the book (from 0 to 5).

        Returns
        -------
        bool
            True if the book was rated successfully.

        Raises
        ------
        ValueError
            If the rating is not between 0 and 5.
        ProfileError
            If the service fails to persist the rating.

        Examples
        --------
        >>> service.rate_book(10, 4.5)
        True
        """
        return run_sync(self._rate_book(edition_id, rating))

`init(client, auth_service)`

Initialize the service with dependencies.

This service requires an authenticated session via :class:AuthService and is typically used alongside :class:UserService when manipulating the logged user's bookshelf and other profile metadata.

Parameters:

Name	Type	Description	Default
`client`	`SyncHTTPClient`	The HTTP client to use for requests.	required
`auth_service`	`AuthService`	The authentication service.	required

Source code in pyskoob/profile.py

def __init__(self, client: SyncHTTPClient, auth_service: AuthService):
    """Initialize the service with dependencies.

    This service requires an authenticated session via
    :class:`AuthService` and is typically used alongside
    :class:`UserService` when manipulating the logged user's bookshelf
    and other profile metadata.

    Parameters
    ----------
    client : SyncHTTPClient
        The HTTP client to use for requests.
    auth_service : AuthService
        The authentication service.
    """
    super().__init__(client, auth_service)

`add_book_label(edition_id, label)`

Adds a label to a book.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	The edition ID of the book.	required
`label`	`BookLabel`	The label to add.	required

Returns:

Type	Description
`bool`	True if the label was added successfully, False otherwise.

Examples:

>>> service.add_book_label(10, BookLabel.FAVORITE)
True

Source code in pyskoob/profile.py

def add_book_label(self, edition_id: int, label: BookLabel) -> bool:
    """
    Adds a label to a book.

    Parameters
    ----------
    edition_id : int
        The edition ID of the book.
    label : BookLabel
        The label to add.

    Returns
    -------
    bool
        True if the label was added successfully, False otherwise.

    Examples
    --------
    >>> service.add_book_label(10, BookLabel.FAVORITE)
    True
    """
    return run_sync(self._add_book_label(edition_id, label))

`change_book_shelf(edition_id, bookshelf)`

Changes the bookshelf of a book.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	The edition ID of the book.	required
`bookshelf`	`BookShelf`	The new bookshelf for the book.	required

Returns:

Type	Description
`bool`	True if the bookshelf was changed successfully, False otherwise.

Examples:

>>> service.change_book_shelf(10, BookShelf.BOOK)
True

Source code in pyskoob/profile.py

def change_book_shelf(self, edition_id: int, bookshelf: BookShelf) -> bool:
    """
    Changes the bookshelf of a book.

    Parameters
    ----------
    edition_id : int
        The edition ID of the book.
    bookshelf : BookShelf
        The new bookshelf for the book.

    Returns
    -------
    bool
        True if the bookshelf was changed successfully, False otherwise.

    Examples
    --------
    >>> service.change_book_shelf(10, BookShelf.BOOK)
    True
    """
    return run_sync(self._change_book_shelf(edition_id, bookshelf))

`rate_book(edition_id, rating)`

Rates a book.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	The edition ID of the book.	required
`rating`	`float`	The rating to give to the book (from 0 to 5).	required

Returns:

Type	Description
`bool`	True if the book was rated successfully.

Raises:

Type	Description
`ValueError`	If the rating is not between 0 and 5.
`ProfileError`	If the service fails to persist the rating.

Examples:

>>> service.rate_book(10, 4.5)
True

Source code in pyskoob/profile.py

def rate_book(self, edition_id: int, rating: float) -> bool:
    """Rates a book.

    Parameters
    ----------
    edition_id : int
        The edition ID of the book.
    rating : float
        The rating to give to the book (from 0 to 5).

    Returns
    -------
    bool
        True if the book was rated successfully.

    Raises
    ------
    ValueError
        If the rating is not between 0 and 5.
    ProfileError
        If the service fails to persist the rating.

    Examples
    --------
    >>> service.rate_book(10, 4.5)
    True
    """
    return run_sync(self._rate_book(edition_id, rating))

`remove_book_label(edition_id)`

Removes a label from a book.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	The edition ID of the book.	required

Returns:

Type	Description
`bool`	True if the label was removed successfully, False otherwise.

Examples:

>>> service.remove_book_label(10)
True

Source code in pyskoob/profile.py

def remove_book_label(self, edition_id: int) -> bool:
    """
    Removes a label from a book.

    Parameters
    ----------
    edition_id : int
        The edition ID of the book.

    Returns
    -------
    bool
        True if the label was removed successfully, False otherwise.

    Examples
    --------
    >>> service.remove_book_label(10)
    True
    """
    return run_sync(self._remove_book_label(edition_id))

`remove_book_status(edition_id)`

Removes the status of a book.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	The edition ID of the book.	required

Returns:

Type	Description
`bool`	True if the status was removed successfully, False otherwise.

Examples:

>>> service.remove_book_status(10)
True

Source code in pyskoob/profile.py

def remove_book_status(self, edition_id: int) -> bool:
    """
    Removes the status of a book.

    Parameters
    ----------
    edition_id : int
        The edition ID of the book.

    Returns
    -------
    bool
        True if the status was removed successfully, False otherwise.

    Examples
    --------
    >>> service.remove_book_status(10)
    True
    """
    return run_sync(self._remove_book_status(edition_id))

`update_book_status(edition_id, status)`

Updates the status of a book.

Parameters:

Name	Type	Description	Default
`edition_id`	`int`	The edition ID of the book.	required
`status`	`BookStatus`	The new status for the book.	required

Returns:

Type	Description
`bool`	True if the status was updated successfully, False otherwise.

Examples:

>>> service.update_book_status(10, BookStatus.READ)
True

Source code in pyskoob/profile.py

def update_book_status(self, edition_id: int, status: BookStatus) -> bool:
    """
    Updates the status of a book.

    Parameters
    ----------
    edition_id : int
        The edition ID of the book.
    status : BookStatus
        The new status for the book.

    Returns
    -------
    bool
        True if the status was updated successfully, False otherwise.

    Examples
    --------
    >>> service.update_book_status(10, BookStatus.READ)
    True
    """
    return run_sync(self._update_book_status(edition_id, status))

Profile Service

Example

AsyncSkoobProfileService

add_book_label(edition_id, label) async

change_book_shelf(edition_id, bookshelf) async

rate_book(edition_id, rating) async

remove_book_label(edition_id) async

remove_book_status(edition_id) async

update_book_status(edition_id, status) async

SkoobProfileService

__init__(client, auth_service)

add_book_label(edition_id, label)

change_book_shelf(edition_id, bookshelf)

rate_book(edition_id, rating)

remove_book_label(edition_id)

remove_book_status(edition_id)

update_book_status(edition_id, status)

`AsyncSkoobProfileService`

`add_book_label(edition_id, label)` `async`

`change_book_shelf(edition_id, bookshelf)` `async`

`rate_book(edition_id, rating)` `async`

`remove_book_label(edition_id)` `async`

`remove_book_status(edition_id)` `async`

`update_book_status(edition_id, status)` `async`

`SkoobProfileService`

`init(client, auth_service)`

`add_book_label(edition_id, label)`

`change_book_shelf(edition_id, bookshelf)`

`rate_book(edition_id, rating)`

`remove_book_label(edition_id)`

`remove_book_status(edition_id)`

`update_book_status(edition_id, status)`