Habiticalib 0.2.0a1__py3-none-any.whl → 0.3.0__py3-none-any.whl

habiticalib/__init__.py

@@ -8,16 +8,21 @@ from .exceptions import (
     NotFoundError,
     TooManyRequestsError,
 )
+from .helpers import deserialize_task
 from .lib import Habitica
 from .types import (
     Attributes,
+    ChangeClassData,
+    ContentData,
     Direction,
     Frequency,
     HabiticaClass,
     HabiticaClassSystemResponse,
+    HabiticaContentResponse,
     HabiticaErrorResponse,
     HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
+    HabiticaQuestResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
     HabiticaSleepResponse,
@@ -27,31 +32,44 @@ 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",
     "HabiticaClass",
     "HabiticaClassSystemResponse",
+    "HabiticaContentResponse",
     "HabiticaErrorResponse",
     "HabiticaException",
     "HabiticaGroupMembersResponse",
     "HabiticaLoginResponse",
+    "HabiticaQuestResponse",
     "HabiticaResponse",
     "HabiticaScoreResponse",
     "HabiticaSleepResponse",
@@ -61,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/const.py

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

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
 
@@ -31,6 +32,7 @@ from .types import (
     Direction,
     HabiticaClass,
     HabiticaClassSystemResponse,
+    HabiticaContentResponse,
     HabiticaErrorResponse,
     HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
@@ -44,6 +46,7 @@ from .types import (
     HabiticaTaskOrderResponse,
     HabiticaTaskResponse,
     HabiticaTasksResponse,
+    HabiticaUserAnonymized,
     HabiticaUserExport,
     HabiticaUserResponse,
     Language,
@@ -205,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.
 
@@ -218,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
         -------
@@ -252,25 +247,67 @@ 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,
         due_date: datetime | None = None,
-    ) -> HabiticaResponse:
+    ) -> HabiticaTasksResponse:
         """Get the authenticated user's tasks.
 
         Parameters
         ----------
         task_type : TaskFilter | None
             The type of task to retrieve, defined in TaskFilter enum.
-            If `None`, all task types will be retrieved (default is None).
+            If `None`, all task types will be retrieved except completed to-dos
+            (default is None).
 
         due_date : datetime | None
             Optional date to use for computing the nextDue field for each returned task.
@@ -458,7 +495,7 @@ class Habitica:
         Returns
         -------
         HabiticaTaskResponse
-            A response object containing the data for the deleted task.
+            A response containing an empty data object.
 
         Raises
         ------
@@ -562,7 +599,7 @@ class Habitica:
     async def get_content(
         self,
         language: Language | None = None,
-    ) -> HabiticaResponse:
+    ) -> HabiticaContentResponse:
         """
         Fetch game content from the Habitica API.
 
@@ -604,7 +641,7 @@ class Habitica:
         if language:
             params.update({"language": language.value})
 
-        return HabiticaResponse.from_json(
+        return HabiticaContentResponse.from_json(
             await self._request("get", url=url, params=params),
         )
 
@@ -1996,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/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
@@ -591,7 +591,7 @@ class PreferencesUser:
     webhooks: dict = field(default_factory=dict)
     improvementCategories: list[str] = field(default_factory=list)
     timezoneOffsetAtLastCron: int | None = None
-    language: str | None = None
+    language: Language | None = None
 
 
 @dataclass(kw_only=True)
@@ -662,13 +662,6 @@ class StatsUser:
     Int: int | None = field(default=None, metadata=field_options(alias="int"))
 
 
-field(
-    metadata=field_options(
-        deserialize=serialize_datetime,
-    )
-)
-
-
 @dataclass(kw_only=True)
 class TagsUser:
     """Tags user data."""
@@ -1048,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."""
@@ -1255,3 +1263,387 @@ class TaskPriority(Enum):
     EASY = 1
     MEDIUM = 1.5
     HARD = 2
+
+
+@dataclass
+class AchievmentContent:
+    """Achievment content data."""
+
+    icon: str
+    key: str
+    titleKey: str | None = None
+    textKey: str | None = None
+    singularTitleKey: str | None = None
+    singularTextKey: str | None = None
+    pluralTitleKey: str | None = None
+    pluralTextKey: str | None = None
+
+
+@dataclass
+class AnimalColorAchievementContent:
+    """animalColorAchievement content data."""
+
+    color: str
+    petAchievement: str
+    petNotificationType: str
+    mountAchievement: str
+    mountNotificationType: str
+
+
+@dataclass
+class AnimalSetAchievementContent:
+    """animalSetAchievements content data."""
+
+    Type: str = field(metadata=field_options(alias="type"))
+    species: list[str]
+    achievementKey: str
+    notificationType: str
+
+
+@dataclass
+class StableAchievementContent:
+    """stableAchievements content data."""
+
+    masterAchievement: str
+    masterNotificationType: str
+
+
+@dataclass
+class PetSetCompleteAchievsContent:
+    """petSetCompleteAchievs content data."""
+
+    color: str
+    petAchievement: str
+    petNotificationType: str
+
+
+@dataclass
+class QuestBossRage:
+    """QuestBossRage content data."""
+
+    title: str
+    description: str
+    value: float
+    effect: str | None = None
+    healing: float | None = None
+
+
+@dataclass
+class QuestBoss:
+    """QuestBoss content data."""
+
+    name: str
+    hp: float
+    Str: float = field(metadata=field_options(alias="str"))
+    Def: float = field(metadata=field_options(alias="def"))
+    rage: QuestBossRage | None = None
+
+
+@dataclass
+class QuestItem:
+    """QuestItem content data."""
+
+    Type: str = field(metadata=field_options(alias="type"))
+    key: str
+    text: str
+
+
+@dataclass
+class QuestDrop:
+    """QuestDrop content data."""
+
+    gp: float
+    exp: float
+    items: list[QuestItem] | None = None
+
+
+@dataclass
+class QuestCollect:
+    """QuestCollect content data."""
+
+    text: str
+    count: int
+
+
+@dataclass
+class QuestUnlockCondition:
+    """QuestUnlockCondition content data."""
+
+    condition: str
+    text: str
+
+
+@dataclass
+class QuestsContent:
+    """petSetCompleteAchievs content data."""
+
+    text: str
+    notes: str
+
+    completion: str
+    category: str
+
+    drop: QuestDrop
+    key: str
+    goldValue: float | None = None
+    value: float | None = None
+    previous: str | None = None
+    prereqQuests: list[str] | None = None
+    collect: dict[str, QuestCollect] | None = None
+    unlockCondition: QuestUnlockCondition | None = None
+    boss: QuestBoss | None = None
+    group: str | None = None
+
+
+@dataclass
+class ItemListEntry:
+    """ItemListEntry content data."""
+
+    localeKey: str
+    isEquipment: bool
+
+
+@dataclass
+class ItemListContent:
+    """ItemListContent content data."""
+
+    weapon: ItemListEntry
+    armor: ItemListEntry
+    head: ItemListEntry
+    shield: ItemListEntry
+    back: ItemListEntry
+    body: ItemListEntry
+    headAccessory: ItemListEntry
+    eyewear: ItemListEntry
+    hatchingPotions: ItemListEntry
+    premiumHatchingPotions: ItemListEntry
+    eggs: ItemListEntry
+    quests: ItemListEntry
+    food: ItemListEntry
+    Saddle: ItemListEntry
+    bundles: ItemListEntry
+
+
+@dataclass
+class GearEntry:
+    """GearEntry content data."""
+
+    text: str
+    notes: str
+    Int: int = field(metadata=field_options(alias="int"))
+    value: int
+    Type: str = field(metadata=field_options(alias="type"))
+    key: str
+    Set: str = field(metadata=field_options(alias="set"))
+    klass: str
+    index: str
+    Str: int = field(metadata=field_options(alias="str"))
+    per: int
+    con: int
+
+
+@dataclass
+class GearClass:
+    """GearClass content data."""
+
+    base: dict[str, GearEntry] | None = None
+    warrior: dict[str, GearEntry] | None = None
+    wizard: dict[str, GearEntry] | None = None
+    rogue: dict[str, GearEntry] | None = None
+    special: dict[str, GearEntry] | None = None
+    armoire: dict[str, GearEntry] | None = None
+    mystery: dict[str, GearEntry] | None = None
+    healer: dict[str, GearEntry] | None = None
+
+
+@dataclass
+class GearType:
+    """GearType content data."""
+
+    weapon: GearClass
+    armor: GearClass
+    head: GearClass
+    shield: GearClass
+    back: GearClass
+    body: GearClass
+    headAccessory: GearClass
+    eyewear: GearClass
+
+
+@dataclass
+class GearContent:
+    """GearContent content data."""
+
+    tree: GearType
+    flat: dict[str, GearEntry]
+
+
+@dataclass
+class SpellEntry:
+    """SpellEntry content data."""
+
+    text: str
+    mana: int
+    target: str
+    notes: str
+    key: str
+    previousPurchase: bool | None = None
+    limited: bool | None = None
+    lvl: int | None = None
+    value: int | None = None
+    immediateUse: bool | None = None
+    purchaseType: str | None = None
+    silent: bool | None = None
+
+
+@dataclass
+class SpellsClass:
+    """SpellsClass content data."""
+
+    wizard: dict[str, SpellEntry]
+    warrior: dict[str, SpellEntry]
+    rogue: dict[str, SpellEntry]
+    healer: dict[str, SpellEntry]
+    special: dict[str, SpellEntry]
+
+
+@dataclass
+class CarTypes:
+    """CarTypes content data."""
+
+    key: str
+    messageOptions: int
+    yearRound: bool = False
+
+
+@dataclass
+class SpecialItemEntry:
+    """Item content data."""
+
+    key: str | None = None
+    text: str | None = None
+    notes: str | None = None
+    immediateUse: bool | None = None
+    limited: bool | None = None
+    mana: int | None = None
+    previousPurchase: bool | None = None
+    purchaseType: str | None = None
+    silent: bool | None = None
+    target: str | None = None
+    value: int | None = None
+
+
+@dataclass
+class EggEntry:
+    """Egg content data."""
+
+    text: str | None = None
+    mountText: str | None = None
+    adjective: str | None = None
+    value: int | None = None
+    key: str | None = None
+    notes: str | None = None
+
+
+@dataclass
+class HatchingPotionEntry:
+    """Hatching potion content data."""
+
+    value: int | None = None
+    key: str | None = None
+    text: str | None = None
+    notes: str | None = None
+    premium: bool | None = None
+    limited: bool | None = None
+    _addlNotes: str | None = None
+    wacky: bool | None = None
+
+
+@dataclass
+class PetEntry:
+    """Pet content data."""
+
+    key: str | None = None
+    Type: str | None = field(default=None, metadata=field_options(alias="type"))
+    potion: str | None = None
+    egg: str | None = None
+    text: str | None = None
+
+
+@dataclass
+class InventoryItemEntry:
+    """Inventory item content data."""
+
+    text: str | None = None
+    textA: str | None = None
+    textThe: str | None = None
+    target: str | None = None
+    value: int | None = None
+    key: str | None = None
+    notes: str | None = None
+    canDrop: bool | None = None
+
+
+@dataclass
+class ContentData:
+    """Content data."""
+
+    achievements: dict[str, AchievmentContent]
+    questSeriesAchievements: dict[str, list[str]]
+    animalColorAchievements: list[AnimalColorAchievementContent]
+    animalSetAchievements: dict[str, AnimalSetAchievementContent]
+    stableAchievements: dict[str, StableAchievementContent]
+    petSetCompleteAchievs: list[PetSetCompleteAchievsContent]
+    quests: dict[str, QuestsContent]
+    questsByLevel: list[QuestsContent]
+    userCanOwnQuestCategories: list[str]
+    itemList: ItemListContent
+    gear: GearContent
+    spells: SpellsClass
+    audioThemes: list[str]
+    # mystery
+    officialPinnedItems: list
+    # bundles
+    # potion
+    # armoire
+    # events
+    # repeatingEvents
+    classes: list[str]
+    gearTypes: list[str]
+    cardTypes: dict[str, CarTypes]
+    special: dict[str, SpecialItemEntry]
+    dropEggs: dict[str, EggEntry]
+    questEggs: dict[str, EggEntry]
+    eggs: dict[str, EggEntry]
+    # timeTravelStable
+    dropHatchingPotions: dict[str, HatchingPotionEntry]
+    premiumHatchingPotions: dict[str, HatchingPotionEntry]
+    wackyHatchingPotions: dict[str, HatchingPotionEntry]
+    hatchingPotions: dict[str, HatchingPotionEntry]
+    pets: dict[str, bool]
+    premiumPets: dict[str, bool]
+    questPets: dict[str, bool]
+    specialPets: dict[str, str]
+    wackyPets: dict[str, bool]
+    petInfo: dict[str, PetEntry]
+    mounts: dict[str, bool]
+    premiumMounts: dict[str, bool]
+    questMounts: dict[str, bool]
+    specialMounts: dict[str, str]
+    mountInfo: dict[str, PetEntry]
+    food: dict[str, InventoryItemEntry]
+    # appearances
+    # backgrounds
+    # backgroundsFlat
+    # userDefaults
+    # tasksByCategory
+    # userDefaultsMobile
+    # faq
+    # loginIncentives
+
+
+@dataclass
+class HabiticaContentResponse(HabiticaResponse):
+    """Representation of a content response."""
+
+    data: ContentData

{habiticalib-0.2.0a1.dist-info → habiticalib-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Habiticalib
-Version: 0.2.0a1
+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.3.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+habiticalib/__init__.py,sha256=NoFYNqRKuLiMwXWCWdxxkxnubmUplxCb3Ct0kQy0ZYo,2309
+habiticalib/const.py,sha256=4Pqb9TaT1nfrV6Um4OXBpGkLLNqAT7gPACn4dzV5V5Q,624
+habiticalib/exceptions.py,sha256=oVFCGbHkVn0UpIKIPZPzXfvzs9US4R05ebdEn6cOpqM,1350
+habiticalib/helpers.py,sha256=IRZLYWkDVLI0iVBgBMmvZ6L83KCUl-CnzGhUR_tP6Fg,4576
+habiticalib/lib.py,sha256=e-UwtfDWYrxl-N5Ylns7ZgU4knquEximdyBTQz4RcYQ,73500
+habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+habiticalib/types.py,sha256=bh_Fly_piJK-9tbKjS-pZB8Z5LL_pW8MHJj1NfCyb2E,42674
+habiticalib-0.3.0.dist-info/METADATA,sha256=kneBKiOMlRDpX2qdLn6cYbFRBdpl4NOppCjIypw4bG0,4185
+habiticalib-0.3.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+habiticalib-0.3.0.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
+habiticalib-0.3.0.dist-info/RECORD,,

habiticalib-0.2.0a1.dist-info/RECORD

@@ -1,11 +0,0 @@
-habiticalib/__init__.py,sha256=QwR7xcAdEwZ1bAv02KlZCm4sw-8-xKlYOUAaB502mCA,1687
-habiticalib/const.py,sha256=hTmR0O6Bibw96tMCIy-Wsb_AC0K4AH1qiQVCJyJ_TAg,626
-habiticalib/exceptions.py,sha256=oVFCGbHkVn0UpIKIPZPzXfvzs9US4R05ebdEn6cOpqM,1350
-habiticalib/helpers.py,sha256=IRZLYWkDVLI0iVBgBMmvZ6L83KCUl-CnzGhUR_tP6Fg,4576
-habiticalib/lib.py,sha256=_HPEjoH1o0wbSM26mIbzGEbfvAery3O8XDMTmUZEY2U,71271
-habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-habiticalib/types.py,sha256=ZmAkkDzXl9lj9fNWidlzjKkJ0CQStQVBi24u-3mgMPA,33907
-habiticalib-0.2.0a1.dist-info/METADATA,sha256=Yfdhp5dWPEylm1Ri2yU1zC2569oODmC6vSCERfG80mY,4156
-habiticalib-0.2.0a1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-habiticalib-0.2.0a1.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
-habiticalib-0.2.0a1.dist-info/RECORD,,