Habiticalib 0.1.0__py3-none-any.whl

habiticalib-0.1.0.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.3
+Name: Habiticalib
+Version: 0.1.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
+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.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+habiticalib/__init__.py,sha256=rwRSTk3JFaSnVKRniTC82tA5JKPSuQ-AD_mAok2QU_g,1561
+habiticalib/const.py,sha256=OafUalLtmoZePZ8e0ERl9eB0_LQmENsrDARU86GVAjY,607
+habiticalib/exceptions.py,sha256=oVFCGbHkVn0UpIKIPZPzXfvzs9US4R05ebdEn6cOpqM,1350
+habiticalib/helpers.py,sha256=IRZLYWkDVLI0iVBgBMmvZ6L83KCUl-CnzGhUR_tP6Fg,4576
+habiticalib/lib.py,sha256=MMs3BINdbZUszUy_DCWvFWDZKy2or1UA5R47X3GeUwI,54274
+habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+habiticalib/types.py,sha256=7xpxpvpDQBxsyuD241vQxeXjk6zuEC4yXzw-Of7G7Bw,33187
+habiticalib-0.1.0.dist-info/METADATA,sha256=niaG5X8XNWMjMysoLoPzXOJLZfNmjoQNZN7TL9AOYN4,4154
+habiticalib-0.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+habiticalib-0.1.0.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
+habiticalib-0.1.0.dist-info/RECORD,,

habiticalib-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any

habiticalib-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024, Manfred Dennerlein Rodelo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+