Habiticalib 0.2.0a2__tar.gz → 0.3.0__tar.gz

{habiticalib-0.2.0a2 → habiticalib-0.3.0}/.github/release-drafter.yml

@@ -39,6 +39,7 @@ autolabeler:
   - label: 'feature'
     title:
       - '/adds/i'
+      - '/add method/i'
   - label: 'bug'
     title:
       - '/fix/i'
@@ -48,6 +49,7 @@ autolabeler:
   - label: 'testing'
     title:
       - '/test:/i'
+      - '/add test/i'
     files:
       - 'test_*'
       - 'conftest.py'
@@ -78,12 +80,15 @@ version-resolver:
   major:
     labels:
       - 'major'
+      - 'breaking'
   minor:
     labels:
       - 'minor'
+      - 'feature'
   patch:
     labels:
       - 'patch'
+      - 'bug'
   default: patch
 
 template: |

{habiticalib-0.2.0a2 → habiticalib-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Habiticalib
-Version: 0.2.0a2
+Version: 0.3.0
 Summary: Asynchronous Python client library for the Habitica API
 Project-URL: Documentation, https://tr4nt0r.github.io/habiticalib/
 Project-URL: Source, https://github.com/tr4nt0r/habiticalib
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.12
 Requires-Dist: aiohttp~=3.9
+Requires-Dist: habitipy~=0.3.3
 Requires-Dist: mashumaro~=3.13
 Requires-Dist: orjson~=3.10
 Requires-Dist: pillow~=11.0

{habiticalib-0.2.0a2 → habiticalib-0.3.0}/pyproject.toml

@@ -24,7 +24,7 @@ indent-style = "space"
 max-complexity = 25
 
 [tool.ruff.lint.per-file-ignores]
-"types.py" = ["N815"]
+"types.py" = ["N815", "TCH003"]
 "tests/*" = ["SLF001", "S101", "ARG001"]
 
 [tool.pytest.ini_options]
@@ -66,20 +66,20 @@ path = "src/habiticalib/const.py"
 [tool.hatch.envs.default]
 python = "3.12"
 dependencies = [
-    "aiohttp==3.10.10",
-    "mashumaro==3.13.1",
-    "orjson==3.10.7",
+    "aiohttp==3.11.7",
+    "mashumaro==3.15",
+    "orjson==3.10.12",
     "Pillow==11.0.0",
-    "mypy==1.12.0",
-    "ruff==0.7.0",
+    "mypy==1.13.0",
+    "ruff==0.8.0",
     "pytest==8.3.3",
-    "pytest-cov==5.0.0",
-    "mkdocs-material==9.5.41",
-    "mkdocstrings[python]==0.26.2",
+    "pytest-cov==6.0.0",
+    "mkdocs-material==9.5.45",
+    "mkdocstrings[python]==0.27.0",
     "pytest-asyncio==0.24.0",
-    "aioresponses==0.7.6",
+    "aioresponses==0.7.7",
     "pre-commit==4.0.1",
-    "syrupy==4.7.2"
+    "syrupy==4.8.0"
 ]
 installer = "uv"
 
@@ -125,7 +125,8 @@ dependencies = [
     "aiohttp~=3.9",
     "mashumaro~=3.13",
     "orjson~=3.10",
-    "Pillow~=11.0"
+    "Pillow~=11.0",
+    "habitipy~=0.3.3"
 ]
 
 [project.urls]

{habiticalib-0.2.0a2 → habiticalib-0.3.0}/src/habiticalib/__init__.py

@@ -8,9 +8,12 @@ from .exceptions import (
     NotFoundError,
     TooManyRequestsError,
 )
+from .helpers import deserialize_task
 from .lib import Habitica
 from .types import (
     Attributes,
+    ChangeClassData,
+    ContentData,
     Direction,
     Frequency,
     HabiticaClass,
@@ -29,22 +32,33 @@ from .types import (
     HabiticaTaskOrderResponse,
     HabiticaTaskResponse,
     HabiticaTasksResponse,
+    HabiticaUserAnonymized,
     HabiticaUserExport,
     HabiticaUserResponse,
     Language,
+    LoginData,
+    QuestData,
+    ScoreData,
     Skill,
+    StatsUser,
+    TagsUser,
     Task,
+    TaskData,
     TaskFilter,
+    TaskPriority,
     TaskType,
+    UserAnonymizedData,
+    UserData,
     UserStyles,
 )
 
 __all__ = [
-    "__version__",
     "ASSETS_URL",
+    "DEFAULT_URL",
     "Attributes",
     "BadRequestError",
-    "DEFAULT_URL",
+    "ChangeClassData",
+    "ContentData",
     "Direction",
     "Frequency",
     "Habitica",
@@ -65,15 +79,27 @@ __all__ = [
     "HabiticaTaskOrderResponse",
     "HabiticaTaskResponse",
     "HabiticaTasksResponse",
+    "HabiticaUserAnonymized",
     "HabiticaUserExport",
     "HabiticaUserResponse",
     "Language",
+    "LoginData",
     "NotAuthorizedError",
     "NotFoundError",
+    "QuestData",
+    "ScoreData",
     "Skill",
+    "StatsUser",
+    "TagsUser",
     "Task",
+    "TaskData",
     "TaskFilter",
+    "TaskPriority",
     "TaskType",
     "TooManyRequestsError",
+    "UserAnonymizedData",
+    "UserData",
     "UserStyles",
+    "__version__",
+    "deserialize_task",
 ]

{habiticalib-0.2.0a2 → habiticalib-0.3.0}/src/habiticalib/const.py

@@ -1,6 +1,6 @@
 """Constants for Habiticalib."""
 
-__version__ = "0.2.0a2"
+__version__ = "0.3.0"
 
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"

{habiticalib-0.2.0a2 → habiticalib-0.3.0}/src/habiticalib/lib.py

@@ -6,9 +6,10 @@ import asyncio
 from http import HTTPStatus
 from io import BytesIO
 import logging
-from typing import IO, TYPE_CHECKING, Self
+from typing import IO, TYPE_CHECKING, Any, Self
 
 from aiohttp import ClientError, ClientResponseError, ClientSession
+from habitipy.aio import HabitipyAsync  # type: ignore[import-untyped]
 from PIL import Image
 from yarl import URL
 
@@ -45,6 +46,7 @@ from .types import (
     HabiticaTaskOrderResponse,
     HabiticaTaskResponse,
     HabiticaTasksResponse,
+    HabiticaUserAnonymized,
     HabiticaUserExport,
     HabiticaUserResponse,
     Language,
@@ -206,10 +208,7 @@ class Habitica:
         return response
 
     async def get_user(
-        self,
-        user_fields: str | list[str] | None = None,
-        *,
-        anonymized: bool = False,
+        self, user_fields: str | list[str] | None = None
     ) -> HabiticaUserResponse:
         """Get the authenticated user's profile.
 
@@ -219,11 +218,6 @@ class Habitica:
             A string or a list of fields to include in the response.
             If provided as a list, the fields will be joined with commas.
             If None, the full user profile document is returned. Default is None.
-        anonymized : bool
-            When True, returns the user's data without: Authentication information,
-            New Messages/Invitations/Inbox, Profile, Purchased information,
-            Contributor information, Special items, Webhooks, Notifications.
-            (default is False)
 
         Returns
         -------
@@ -253,13 +247,54 @@ class Habitica:
 
         if user_fields:
             params = {"userFields": join_fields(user_fields)}
-        if anonymized:
-            url = url / "anonymized"
 
         return HabiticaUserResponse.from_json(
             await self._request("get", url=url, params=params),
         )
 
+    async def get_user_anonymized(
+        self,
+    ) -> HabiticaUserAnonymized:
+        """Get the authenticated user's anonymized profile.
+
+        This method retrieves the user's profile data while excluding sensitive
+        and personally identifiable information such as authentication details,
+        profile data, purchased items, contributor information, special items,
+        webhooks, and notifications.
+
+        Returns
+        -------
+        HabiticaUserAnonymized
+            A response object containing the anonymized user profile data.
+
+
+        Raises
+        ------
+        NotAuthorizedError
+            If the API request is unauthorized (HTTP 401).
+        aiohttp.ClientResponseError
+            For other HTTP-related errors raised by aiohttp, such as HTTP 400 or 500.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            For any other exceptions raised by aiohttp during the request.
+        TimeoutError
+            If the connection times out.
+
+        Examples
+        --------
+        >>> response = await habitica.get_user_anonymized()
+        >>> response.data.user  # Access the anonymized user data
+        >>> response.data.tasks  # Access the user's anonymized tasks
+        """
+        url = self.url / "api/v3/user"
+
+        url = url / "anonymized"
+
+        return HabiticaUserAnonymized.from_json(
+            await self._request("get", url=url),
+        )
+
     async def get_tasks(
         self,
         task_type: TaskFilter | None = None,
@@ -1998,3 +2033,33 @@ class Habitica:
             image.save(fp, fmt)
 
         return user_styles
+
+    async def habitipy(self) -> HabitipyAsync:
+        """Create a Habitipy instance."""
+
+        _session = self._session
+        _headers = self._headers
+        loop = asyncio.get_running_loop()
+
+        class HAHabitipyAsync(HabitipyAsync):
+            """Closure API class to hold session."""
+
+            def __call__(self, **kwargs) -> Any:
+                """Pass session to habitipy."""
+                return super().__call__(_session, **kwargs)
+
+            def _make_headers(self) -> dict[str, str]:
+                """Inject headers."""
+                headers = super()._make_headers()
+                headers.update(_headers)
+                return headers
+
+        return await loop.run_in_executor(
+            None,
+            HAHabitipyAsync,
+            {
+                "url": str(self.url),
+                "login": self._headers.get("X-API-USER"),
+                "password": self._headers.get("X-API-KEY"),
+            },  # type: ignore[var-annotated]
+        )

{habiticalib-0.2.0a2 → habiticalib-0.3.0}/src/habiticalib/types.py

@@ -8,7 +8,7 @@ import datetime as dt
 from datetime import UTC, datetime
 from enum import Enum, StrEnum
 from typing import Any, NotRequired, TypedDict
-from uuid import UUID  # noqa: TCH003
+from uuid import UUID
 
 from mashumaro import field_options
 from mashumaro.mixins.orjson import DataClassORJSONMixin
@@ -1041,6 +1041,21 @@ class HabiticaUserExport(UserData, DataClassORJSONMixin):
     tasks: TasksUserExport = field(default_factory=TasksUserExport)
 
 
+@dataclass
+class UserAnonymizedData:
+    """Anonymized user data."""
+
+    user: UserData = field(default_factory=UserData)
+    tasks: list[TaskData] = field(default_factory=list)
+
+
+@dataclass(kw_only=True)
+class HabiticaUserAnonymized(DataClassORJSONMixin):
+    """Representation of a anonymized user data export."""
+
+    data: UserAnonymizedData
+
+
 @dataclass(kw_only=True)
 class HabiticaStatsResponse(HabiticaResponse):
     """Representation of a response containing stats data."""