Habiticalib 0.1.0a1__tar.gz → 0.1.0a3__tar.gz

{habiticalib-0.1.0a1 → habiticalib-0.1.0a3}/.github/labels.yml

@@ -25,7 +25,7 @@
 - name: duplicate
   description: This issue or pull request already exists
   color: cfd3d7
-- name: enhancement
+- name: feature
   description: New feature or request
   color: a2eeef
 - name: github_actions
@@ -49,17 +49,17 @@
 - name: question
   description: Further information is requested
   color: d876e3
-- name: refactoring
-  description: Refactoring
+- name: code quality
+  description: Code quality improvements
   color: ef67c4
-- name: removal
+- name: deprecation
   description: Removals and Deprecations
   color: 9ae7ea
 - name: style
   description: Style
   color: c120e5
 - name: testing
-  description: Testing
+  description: Pull request that adds tests
   color: b1fc6f
 - name: wontfix
   description: This will not be worked on

habiticalib-0.1.0a3/.github/release-drafter.yml

@@ -0,0 +1,94 @@
+name-template: '$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+
+
+categories:
+  - title: '⚠️ Breaking changes'
+    labels:
+      - 'breaking'
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'bug'
+  - title: '⏳ Deprecations'
+    labels:
+      - 'deprecation'
+  - title: '📃 Documentation'
+    labels:
+      - 'documentation'
+  - title: '🧩 Dependency Updates'
+    labels:
+      - 'dependencies'
+      - 'github_actions'
+    collapse-after: 5
+  - title: '🧰 Maintenance'
+    labels:
+      - 'perfomance'
+      - 'refactor'
+      - 'ci'
+      - 'build'
+  - title: '🔬 Other updates'
+    labels:
+      - 'style'
+      - 'testing'
+
+autolabeler:
+  - label: 'feature'
+    title:
+      - '/adds/i'
+  - label: 'bug'
+    title:
+      - '/fix/i'
+  - label: 'code quality'
+    title:
+      - '/Refactor/i'
+  - label: 'testing'
+    title:
+      - '/test:/i'
+    files:
+      - 'test_*'
+      - 'conftest.py'
+  - label: 'documentation'
+    title:
+      - '/docs:/i'
+    files:
+      - '*.md'
+      - 'mkdocs.yml'
+  - label: 'ci'
+    title:
+      - '/ci:/i'
+    files:
+      - '.github/*'
+  - label: 'dependencies'
+    title:
+      - '/bump/i'
+  - label: 'deprecation'
+    title:
+      - '/Deprecate/i'
+
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+exclude-contributors:
+  - 'tr4nt0r'
+
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+
+template: |
+  ## Changes
+
+  $CHANGES
+
+  Special thanks to: $CONTRIBUTORS

{habiticalib-0.1.0a1 → habiticalib-0.1.0a3}/.github/workflows/build.yml

@@ -27,7 +27,7 @@ jobs:
     - name: Test
       run: |
         hatch run test-cov-xml
-    - uses: codecov/codecov-action@v4
+    - uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         fail_ci_if_error: true

habiticalib-0.1.0a3/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.3
+Name: Habiticalib
+Version: 0.1.0a3
+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
+Author-email: Manfred Dennerlein Rodelo <manfred@dennerlein.name>
+License: MIT License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.12
+Requires-Dist: aiohttp~=3.9
+Requires-Dist: mashumaro~=3.13
+Requires-Dist: orjson~=3.10
+Requires-Dist: pillow~=11.0
+Description-Content-Type: text/markdown
+
+# Habiticalib
+
+<p align="center">
+    <em>Modern asynchronous Python client library for the Habitica API</em>
+</p>
+
+[![build](https://github.com/tr4nt0r/habiticalib/workflows/Build/badge.svg)](https://github.com/tr4nt0r/habiticalib/actions)
+[![codecov](https://codecov.io/gh/tr4nt0r/habiticalib/graph/badge.svg?token=iEsZ1Ktj7d)](https://codecov.io/gh/tr4nt0r/habiticalib)
+[![PyPI version](https://badge.fury.io/py/habiticalib.svg)](https://badge.fury.io/py/habiticalib)
+
+**Habiticalib** is a Python library for interacting with the [Habitica API](https://habitica.com). It provides an organized, typed interface to work with Habitica’s features, including tasks, user data, and avatars. The goal of this library is to simplify integration with Habitica.
+
+## Key features
+
+- **Asynchronous**: The library is fully asynchronous, allowing non-blocking API calls.
+- **Fully typed with Dataclasses**: The library is fully typed using Python `dataclasses`. It handles serialization with `mashumaro` and `orjson` for efficient conversion between Habitica API JSON data and Python objects.
+- **Dynamic avatar image generation**: Habiticalib can fetch all necessary assets (like equipped items, pets, and mounts) and combine them into a single avatar image. This image can be saved to disk or returned as a byte buffer for further processing.
+ **Fetch user data**: Retrieve and manage user data such as stats, preferences, and items. User data is structured with dataclasses to make it easy to work with.
+- **Task management**: Support for creating, updating, and retrieving Habitica tasks (to-dos, dailies, habits, rewards) is provided.
+- **Task status updates**: The library allows updates for task statuses, habit scoring, and daily completion.
+- **Tags**: Habiticalib supports the creation, updating and deletion of tags.
+-  **Stat allocation, class cystem and sleep**: The library offers methods for stat point allocation and switching between Habitica classes. It also provides the ability to disable the class system and pausing damage(resting in the inn)
+
+## Installation
+
+```bash
+pip install habiticalib
+```
+
+## Getting started
+Here’s an example to demonstrate basic usage:
+
+```python
+import asyncio
+
+from aiohttp import ClientSession
+
+from habiticalib import Habitica, TaskType
+
+
+async def main():
+    async with ClientSession() as session:
+       habitica = Habitica(session)
+
+       # Login to Habitica
+       habitica.login(username="your_username", password="your_password")
+
+       # Fetch user data
+       user_data = await habitica.user()
+       print(f"Your current health: {user_data.stats.hp}")
+
+        # Fetch all tasks (to-dos, dailies, habits, and rewards)
+        tasks = await habitica.get_tasks()
+        print("All tasks:")
+        for task in tasks:
+            print(f"- {task.text} (type: {task.type})")
+
+        # Fetch only to-dos
+        todos = await habitica.get_tasks(task_type=TaskType.TODO)
+        print("\nTo-Do tasks:")
+        for todo in todos:
+            print(f"- {todo.text} (due: {todo.date})")
+
+        # Fetch only dailies
+        dailies = await habitica.tasks(task_type=TaskType.DAILY)
+        print("\nDailies:")
+        for daily in dailies:
+            print(f"- {daily.text}")
+
+asyncio.run(main())
+```
+
+## Documentation
+
+For full documentation and detailed usage examples, please visit the [Habiticalib documentation](https://tr4nt0r.github.io/habiticalib/).
+
+## License
+
+This project is licensed under the terms of the MIT license.

habiticalib-0.1.0a3/README.md

@@ -0,0 +1,79 @@
+# Habiticalib
+
+<p align="center">
+    <em>Modern asynchronous Python client library for the Habitica API</em>
+</p>
+
+[![build](https://github.com/tr4nt0r/habiticalib/workflows/Build/badge.svg)](https://github.com/tr4nt0r/habiticalib/actions)
+[![codecov](https://codecov.io/gh/tr4nt0r/habiticalib/graph/badge.svg?token=iEsZ1Ktj7d)](https://codecov.io/gh/tr4nt0r/habiticalib)
+[![PyPI version](https://badge.fury.io/py/habiticalib.svg)](https://badge.fury.io/py/habiticalib)
+
+**Habiticalib** is a Python library for interacting with the [Habitica API](https://habitica.com). It provides an organized, typed interface to work with Habitica’s features, including tasks, user data, and avatars. The goal of this library is to simplify integration with Habitica.
+
+## Key features
+
+- **Asynchronous**: The library is fully asynchronous, allowing non-blocking API calls.
+- **Fully typed with Dataclasses**: The library is fully typed using Python `dataclasses`. It handles serialization with `mashumaro` and `orjson` for efficient conversion between Habitica API JSON data and Python objects.
+- **Dynamic avatar image generation**: Habiticalib can fetch all necessary assets (like equipped items, pets, and mounts) and combine them into a single avatar image. This image can be saved to disk or returned as a byte buffer for further processing.
+ **Fetch user data**: Retrieve and manage user data such as stats, preferences, and items. User data is structured with dataclasses to make it easy to work with.
+- **Task management**: Support for creating, updating, and retrieving Habitica tasks (to-dos, dailies, habits, rewards) is provided.
+- **Task status updates**: The library allows updates for task statuses, habit scoring, and daily completion.
+- **Tags**: Habiticalib supports the creation, updating and deletion of tags.
+-  **Stat allocation, class cystem and sleep**: The library offers methods for stat point allocation and switching between Habitica classes. It also provides the ability to disable the class system and pausing damage(resting in the inn)
+
+## Installation
+
+```bash
+pip install habiticalib
+```
+
+## Getting started
+Here’s an example to demonstrate basic usage:
+
+```python
+import asyncio
+
+from aiohttp import ClientSession
+
+from habiticalib import Habitica, TaskType
+
+
+async def main():
+    async with ClientSession() as session:
+       habitica = Habitica(session)
+
+       # Login to Habitica
+       habitica.login(username="your_username", password="your_password")
+
+       # Fetch user data
+       user_data = await habitica.user()
+       print(f"Your current health: {user_data.stats.hp}")
+
+        # Fetch all tasks (to-dos, dailies, habits, and rewards)
+        tasks = await habitica.get_tasks()
+        print("All tasks:")
+        for task in tasks:
+            print(f"- {task.text} (type: {task.type})")
+
+        # Fetch only to-dos
+        todos = await habitica.get_tasks(task_type=TaskType.TODO)
+        print("\nTo-Do tasks:")
+        for todo in todos:
+            print(f"- {todo.text} (due: {todo.date})")
+
+        # Fetch only dailies
+        dailies = await habitica.tasks(task_type=TaskType.DAILY)
+        print("\nDailies:")
+        for daily in dailies:
+            print(f"- {daily.text}")
+
+asyncio.run(main())
+```
+
+## Documentation
+
+For full documentation and detailed usage examples, please visit the [Habiticalib documentation](https://tr4nt0r.github.io/habiticalib/).
+
+## License
+
+This project is licensed under the terms of the MIT license.

{habiticalib-0.1.0a1 → habiticalib-0.1.0a3}/pyproject.toml

@@ -25,7 +25,7 @@ max-complexity = 25
 
 [tool.ruff.lint.per-file-ignores]
 "types.py" = ["N815"]
-"tests/*" = ["SLF001", "S101"]
+"tests/*" = ["SLF001", "S101", "ARG001"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
@@ -61,7 +61,7 @@ allow-direct-references = true
 [tool.hatch.version]
 source = "regex_commit"
 commit_extra_args = ["-e"]
-path = "src/habiticalib/__init__.py"
+path = "src/habiticalib/const.py"
 
 [tool.hatch.envs.default]
 python = "3.12"
@@ -69,7 +69,7 @@ dependencies = [
     "aiohttp==3.10.10",
     "mashumaro==3.13.1",
     "orjson==3.10.7",
-    "Pillow==10.4.0",
+    "Pillow==11.0.0",
     "mypy==1.12.0",
     "ruff==0.7.0",
     "pytest==8.3.3",
@@ -125,7 +125,7 @@ dependencies = [
     "aiohttp~=3.9",
     "mashumaro~=3.13",
     "orjson~=3.10",
-    "Pillow~=10.4"
+    "Pillow~=11.0"
 ]
 
 [project.urls]

habiticalib-0.1.0a3/src/habiticalib/__init__.py

@@ -0,0 +1,71 @@
+"""Modern asynchronous Python client library for the Habitica API."""
+
+from .const import ASSETS_URL, DEFAULT_URL, __version__
+from .exceptions import (
+    BadRequestError,
+    HabiticaException,
+    NotAuthorizedError,
+    NotFoundError,
+    TooManyRequestsError,
+)
+from .lib import Habitica
+from .types import (
+    Attributes,
+    Direction,
+    Frequency,
+    HabiticaClass,
+    HabiticaClassSystemResponse,
+    HabiticaErrorResponse,
+    HabiticaLoginResponse,
+    HabiticaResponse,
+    HabiticaScoreResponse,
+    HabiticaStatsResponse,
+    HabiticaTagResponse,
+    HabiticaTagsResponse,
+    HabiticaTaskOrderResponse,
+    HabiticaTaskResponse,
+    HabiticaTasksResponse,
+    HabiticaUserExport,
+    HabiticaUserResponse,
+    Language,
+    Skill,
+    Task,
+    TaskFilter,
+    TaskType,
+    UserStyles,
+)
+
+__all__ = [
+    "__version__",
+    "ASSETS_URL",
+    "Attributes",
+    "BadRequestError",
+    "DEFAULT_URL",
+    "Direction",
+    "Frequency",
+    "Habitica",
+    "HabiticaClass",
+    "HabiticaClassSystemResponse",
+    "HabiticaErrorResponse",
+    "HabiticaException",
+    "HabiticaLoginResponse",
+    "HabiticaResponse",
+    "HabiticaScoreResponse",
+    "HabiticaStatsResponse",
+    "HabiticaTagResponse",
+    "HabiticaTagsResponse",
+    "HabiticaTaskOrderResponse",
+    "HabiticaTaskResponse",
+    "HabiticaTasksResponse",
+    "HabiticaUserExport",
+    "HabiticaUserResponse",
+    "Language",
+    "NotAuthorizedError",
+    "NotFoundError",
+    "Skill",
+    "Task",
+    "TaskFilter",
+    "TaskType",
+    "TooManyRequestsError",
+    "UserStyles",
+]

{habiticalib-0.1.0a1 → habiticalib-0.1.0a3}/src/habiticalib/const.py

@@ -1,5 +1,7 @@
 """Constants for Habiticalib."""
 
+__version__ = "0.1.0a3"
+
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"
 

habiticalib-0.1.0a3/src/habiticalib/exceptions.py

@@ -0,0 +1,50 @@
+"""Exceptions for Habiticalib."""
+
+from datetime import datetime
+from typing import Self
+
+from multidict import CIMultiDictProxy
+
+from habiticalib.types import HabiticaErrorResponse
+
+
+class HabiticaException(Exception):  # noqa: N818
+    """Base class for Habitica errors."""
+
+    def __init__(
+        self: Self,
+        error: HabiticaErrorResponse,
+        headers: CIMultiDictProxy,
+    ) -> None:
+        """Initialize the Exception."""
+        self.error = error
+        self.rate_limit: int | None = (
+            int(r) if (r := headers.get("x-ratelimit-limit")) else None
+        )
+        self.rate_limit_remaining: int | None = (
+            int(r) if (r := headers.get("x-ratelimit-remaining")) else None
+        )
+        self.rate_limit_reset: datetime | None = (
+            datetime.strptime(r[:33], "%a %b %d %Y %H:%M:%S %Z%z")
+            if (r := headers.get("x-ratelimit-reset"))
+            else None
+        )
+        self.retry_after: int = round(float(headers.get("retry-after", 0)))
+
+        super().__init__(error.message)
+
+
+class NotAuthorizedError(HabiticaException):
+    """NotAuthorized error."""
+
+
+class NotFoundError(HabiticaException):
+    """NotFound error."""
+
+
+class BadRequestError(HabiticaException):
+    """BadRequest error."""
+
+
+class TooManyRequestsError(HabiticaException):
+    """TooManyRequests error."""

{habiticalib-0.1.0a1 → habiticalib-0.1.0a3}/src/habiticalib/helpers.py

@@ -1,13 +1,15 @@
 """Helper functions for Habiticalib."""
 
-from dataclasses import asdict
-from importlib.metadata import version
+from dataclasses import asdict, is_dataclass
+from datetime import date, datetime
+from enum import Enum
 import platform
+from typing import Any
 import uuid
 
 import aiohttp
 
-from .const import DEVELOPER_ID
+from .const import DEVELOPER_ID, __version__
 from .types import HabiticaUserResponse, UserData, UserStyles
 
 
@@ -58,7 +60,7 @@ def get_user_agent() -> str:
     os_info = f"{os_name} {os_release} ({os_version}); {arch}"
 
     return (
-        f"Habiticalib/{version("habiticalib")} ({os_info}) "
+        f"Habiticalib/{__version__} ({os_info}) "
         f"aiohttp/{aiohttp.__version__} Python/{platform.python_version()} "
         " +https://github.com/tr4nt0r/habiticalib)"
     )
@@ -106,10 +108,31 @@ def get_x_client(x_client: str | None = None) -> str:
 
         return x_client
 
-    return f"{DEVELOPER_ID} - Habiticalib/{version("habiticalib")}"
+    return f"{DEVELOPER_ID} - Habiticalib/{__version__}"
 
 
 def extract_user_styles(user_data: HabiticaUserResponse) -> UserStyles:
     """Extract user styles from a user data object."""
     data: UserData = user_data.data
     return UserStyles.from_dict(asdict(data))
+
+
+def deserialize_task(value: Any) -> Any:  # noqa: PLR0911
+    """Recursively convert Enums to values, dates to ISO strings, UUIDs to strings."""
+
+    if is_dataclass(value) and not isinstance(value, type):
+        # Convert dataclass to dict and recursively deserialize
+        return deserialize_task(asdict(value))
+    if isinstance(value, Enum):
+        return value.value  # Convert Enum to its value
+    if isinstance(value, uuid.UUID):
+        return str(value)  # Convert UUID to string
+    if isinstance(value, datetime | date):
+        return value.isoformat()  # Convert datetime/date to ISO string
+    if isinstance(value, list):
+        # Recursively apply deserialization to each item in the list
+        return [deserialize_task(item) for item in value]
+    if isinstance(value, dict):
+        # Recursively apply deserialization to each key-value pair in the dictionary
+        return {k: deserialize_task(v) for k, v in value.items()}
+    return value  # Return other types unchanged