Habiticalib 0.4.0rc4__tar.gz → 0.4.1__tar.gz

{habiticalib-0.4.0rc4 → habiticalib-0.4.1}/.github/workflows/documentation.yml

@@ -31,7 +31,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.12'
+        python-version: '3.13'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

{habiticalib-0.4.0rc4 → habiticalib-0.4.1}/.vscode/settings.json

@@ -18,5 +18,6 @@
       },
       "editor.defaultFormatter": "charliermarsh.ruff"
     },
-    "pylint.enabled": false
+    "pylint.enabled": false,
+    "markdown.validate.enabled": true
   }

habiticalib-0.4.1/CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at <https://github.com/tr4nt0r/habiticalib/issues>.
+
+If you are reporting a bug, please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in
+    troubleshooting.
+- Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with
+"enhancement" and "help wanted" is open to whoever wants to
+implement it.
+
+### Write Documentation
+
+**habiticalib** could always use more documentation, whether as part of the
+official **habiticalib** docs, in docstrings, or even on the web in blog
+posts, articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at
+<https://github.com/tr4nt0r/habiticalib/issues>.
+
+If you are proposing a feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to
+    implement.
+- Remember that this is a volunteer-driven project, and that
+    contributions are welcome :)
+
+## Development
+
+Ready to contribute? Here's how to set up `habiticalib` for
+local development.
+
+### Setup Git
+
+[Fork](https://github.com/tr4nt0r/habiticalib/fork) the `habiticalib` repo on GitHub.
+
+Clone your fork locally:
+
+```bash
+git clone git@github.com:yourusername/habiticalib.git
+```
+
+Create a branch for local development:
+
+``` bash
+git checkout -b name-of-your-bugfix-or-feature
+```
+
+Now you can make your changes locally.
+
+### Setup environment
+
+We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.
+
+### Run unit tests
+
+You can run all the tests with:
+
+```bash
+hatch run test
+```
+
+### Format the code
+
+Execute the following command to apply linting and check typing:
+
+```bash
+hatch run lint
+```
+
+### Publish a new version
+
+You can bump the version, create a commit and associated tag with one command:
+
+```bash
+hatch version patch
+```
+
+```bash
+hatch version minor
+```
+
+```bash
+hatch version major
+```
+
+Your default Git text editor will open so you can add information about the release.
+
+When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated.
+    Put your new functionality into a function with a docstring, and add
+    the feature to the list in README.md.
+3. The pull request should work for Python 3.11 and 3.12. Check
+    <https://github.com/tr4nt0r/habiticalib/actions/workflows/build.yaml>
+    and make sure that the tests pass for all supported Python versions.
+
+## Serve the documentation
+
+You can serve the Mkdocs documentation with:
+
+```bash
+hatch run docs-serve
+```

{habiticalib-0.4.0rc4 → habiticalib-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Habiticalib
-Version: 0.4.0rc4
+Version: 0.4.1
 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
@@ -19,34 +19,47 @@ Description-Content-Type: text/markdown
 
 # Habiticalib
 
-<p align="center">
-    <em>Modern asynchronous Python client library for the Habitica API</em>
-</p>
+Modern asynchronous Python client library for the Habitica API
 
 [![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)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/habiticalib?style=flat&label=pypi%20downloads)
+[!["Buy Me A Coffee"](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://www.buymeacoffee.com/tr4nt0r)
+[![GitHub Sponsor](https://img.shields.io/badge/GitHub-Sponsor-blue?logo=github)](https://github.com/sponsors/tr4nt0r)
+
+---
 
 **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)
+* **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)
+
+---
+
+## 📖 Documentation
+
+* **Full Documentation**: [https://tr4nt0r.github.io/habiticalib](https://tr4nt0r.github.io/habiticalib)
+* **Source Code**: [https://github.com/tr4nt0r/habiticalib](https://github.com/tr4nt0r/habiticalib)
 
-## Installation
+---
+
+## 📦 Installation
 
 ```bash
 pip install habiticalib
 ```
 
-## Getting started
+## 🚀 Getting started
+
 Here’s an example to demonstrate basic usage:
 
 ```python
@@ -89,10 +102,27 @@ async def main():
 asyncio.run(main())
 ```
 
-## Documentation
+---
+
+## 🛠️ Contributing
+
+Contributions are welcome! To contribute:
+
+1. Fork the repository.
+2. Create a new branch.
+3. Make your changes and commit them.
+4. Submit a pull request.
+
+Make sure to follow the [contributing guidelines](CONTRIBUTING.md).
+
+---
+
+## 📜 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-For full documentation and detailed usage examples, please visit the [Habiticalib documentation](https://tr4nt0r.github.io/habiticalib/).
+---
 
-## License
+## ❤️ Support
 
-This project is licensed under the terms of the MIT license.
+If you find this project useful, consider [buying me a coffee ☕](https://www.buymeacoffee.com/tr4nt0r) or [sponsoring me on GitHub](https://github.com/sponsors/tr4nt0r)!

{habiticalib-0.4.0rc4 → habiticalib-0.4.1}/README.md

@@ -1,33 +1,46 @@
 # Habiticalib
 
-<p align="center">
-    <em>Modern asynchronous Python client library for the Habitica API</em>
-</p>
+Modern asynchronous Python client library for the Habitica API
 
 [![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)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/habiticalib?style=flat&label=pypi%20downloads)
+[!["Buy Me A Coffee"](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://www.buymeacoffee.com/tr4nt0r)
+[![GitHub Sponsor](https://img.shields.io/badge/GitHub-Sponsor-blue?logo=github)](https://github.com/sponsors/tr4nt0r)
+
+---
 
 **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)
+* **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)
+
+---
+
+## 📖 Documentation
+
+* **Full Documentation**: [https://tr4nt0r.github.io/habiticalib](https://tr4nt0r.github.io/habiticalib)
+* **Source Code**: [https://github.com/tr4nt0r/habiticalib](https://github.com/tr4nt0r/habiticalib)
 
-## Installation
+---
+
+## 📦 Installation
 
 ```bash
 pip install habiticalib
 ```
 
-## Getting started
+## 🚀 Getting started
+
 Here’s an example to demonstrate basic usage:
 
 ```python
@@ -70,10 +83,27 @@ async def main():
 asyncio.run(main())
 ```
 
-## Documentation
+---
+
+## 🛠️ Contributing
+
+Contributions are welcome! To contribute:
+
+1. Fork the repository.
+2. Create a new branch.
+3. Make your changes and commit them.
+4. Submit a pull request.
+
+Make sure to follow the [contributing guidelines](CONTRIBUTING.md).
+
+---
+
+## 📜 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-For full documentation and detailed usage examples, please visit the [Habiticalib documentation](https://tr4nt0r.github.io/habiticalib/).
+---
 
-## License
+## ❤️ Support
 
-This project is licensed under the terms of the MIT license.
+If you find this project useful, consider [buying me a coffee ☕](https://www.buymeacoffee.com/tr4nt0r) or [sponsoring me on GitHub](https://github.com/sponsors/tr4nt0r)!

{habiticalib-0.4.0rc4 → habiticalib-0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ line-length = 88
 
 [tool.ruff.lint]
 select = ["ALL"]
-ignore = ["TRY003", "D202", "D213", "D417", "ANN003", "ANN401", "E501", "COM812", "ISC001"]
+ignore = ["TRY003", "D202", "D213", "D417", "ANN003", "ANN401", "E501", "COM812", "ISC001", "PLW1641"]
 
 [tool.ruff.lint.isort]
 force-sort-within-sections = true
@@ -75,29 +75,29 @@ path = "src/habiticalib/const.py"
 [tool.hatch.envs.default]
 python = "3.12"
 dependencies = [
-    "aiohttp==3.11.12",
-    "mashumaro==3.15",
-    "orjson==3.10.15",
-    "Pillow==11.1.0",
-    "mypy==1.15.0",
-    "ruff==0.9.6",
-    "pytest==8.3.4",
-    "pytest-cov==6.0.0",
-    "mkdocs-material==9.6.3",
-    "mkdocstrings[python]==0.28.0",
-    "pytest-asyncio==0.25.3",
+    "aiohttp==3.12.14",
+    "mashumaro==3.16",
+    "orjson==3.11.1",
+    "Pillow==11.3.0",
+    "mypy==1.17.0",
+    "ruff==0.12.5",
+    "pytest==8.4.1",
+    "pytest-cov==6.2.1",
+    "mkdocs-material==9.6.16",
+    "mkdocstrings[python]==0.30.0",
+    "pytest-asyncio==1.1.0",
     "aioresponses==0.7.8",
-    "pre-commit==4.1.0",
-    "syrupy==4.8.1"
+    "pre-commit==4.2.0",
+    "syrupy==4.9.1"
 ]
 
 [tool.hatch.envs.hatch-test]
 parallel = true
 extra-dependencies = [
   "aioresponses==0.7.8",
-  "pytest-asyncio==0.25.3",
-  "syrupy==4.8.1",
-  "pytest-cov==6.0.0",
+  "pytest-asyncio==1.1.0",
+  "syrupy==4.9.1",
+  "pytest-cov==6.2.1",
 ]
 extra-args = ["--cov-report=xml", "-vv"]
 type = "virtual"

habiticalib-0.4.1/renovate.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  "rebaseWhen": "behind-base-branch",
+    "labels": [
+    ":recycle: dependencies"
+  ],
+  "commitMessageTopic": "{{depName}}",
+  "commitMessageAction": "Bump",
+  "packageRules": [
+    {
+      "matchManagers": [
+        "pep621"
+      ],
+      "addLabels": [
+        ":snake: python"
+      ]
+    }
+  ]
+}

{habiticalib-0.4.0rc4 → habiticalib-0.4.1}/src/habiticalib/const.py

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

{habiticalib-0.4.0rc4 → habiticalib-0.4.1}/src/habiticalib/typedefs.py

@@ -456,7 +456,7 @@ class FlagsUser(BaseModel):
 class EntryHistory(BaseModel):
     """History entry data."""
 
-    date: datetime = field(
+    date: datetime | None = field(
         metadata=field_options(
             deserialize=serialize_datetime,
         )