Habiticalib 0.1.0__tar.gz

habiticalib-0.1.0/.cruft.json

@@ -0,0 +1,27 @@
+{
+  "template": "https://github.com/tr4nt0r/cookiecutter-hatch",
+  "commit": "8d08540791a735c0668f08b8025719728c7677f9",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "full_name": "Manfred Dennerlein Rodelo",
+      "email": "manfred@dennerlein.name",
+      "github_username": "tr4nt0r",
+      "project_name": "Habiticalib",
+      "dist_name": "habiticalib",
+      "package_name": "habiticalib",
+      "project_short_description": "Modern asynchronous Python client library for the Habitica API",
+      "repository_name": "tr4nt0r/habiticalib",
+      "repository_url": "https://github.com/tr4nt0r/habiticalib",
+      "docs_url": "https://tr4nt0r.github.io/habiticalib/",
+      "open_source_license": "MIT license",
+      "python_version": "3.12",
+      "asyncio": "Y",
+      "docs_icon": "material/library",
+      "docs_color_primary": "deep purple",
+      "docs_color_accent": "purple",
+      "_template": "https://github.com/tr4nt0r/cookiecutter-hatch"
+    }
+  },
+  "directory": null
+}

habiticalib-0.1.0/.editorconfig

@@ -0,0 +1,11 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf

habiticalib-0.1.0/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: [tr4nt0r]
+buy_me_a_coffee: tr4nt0r
+

habiticalib-0.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

habiticalib-0.1.0/.github/labels.yml

@@ -0,0 +1,66 @@
+---
+# Labels names are important as they are used by Release Drafter to decide
+# regarding where to record them in changelog or if to skip them.
+#
+# The repository labels will be automatically configured using this file and
+# the GitHub Action https://github.com/marketplace/actions/github-labeler.
+- name: breaking
+  description: Breaking Changes
+  color: bfd4f2
+- name: bug
+  description: Something isn't working
+  color: d73a4a
+- name: build
+  description: Build System and Dependencies
+  color: bfdadc
+- name: ci
+  description: Continuous Integration
+  color: 4a97d6
+- name: dependencies
+  description: Pull requests that update a dependency file
+  color: 0366d6
+- name: documentation
+  description: Improvements or additions to documentation
+  color: 0075ca
+- name: duplicate
+  description: This issue or pull request already exists
+  color: cfd3d7
+- name: feature
+  description: New feature or request
+  color: a2eeef
+- name: github_actions
+  description: Pull requests that update Github_actions code
+  color: "000000"
+- name: good first issue
+  description: Good for newcomers
+  color: 7057ff
+- name: help wanted
+  description: Extra attention is needed
+  color: 008672
+- name: invalid
+  description: This doesn't seem right
+  color: e4e669
+- name: performance
+  description: Performance
+  color: "016175"
+- name: python
+  description: Pull requests that update Python code
+  color: 2b67c6
+- name: question
+  description: Further information is requested
+  color: d876e3
+- name: code quality
+  description: Code quality improvements
+  color: ef67c4
+- name: deprecation
+  description: Removals and Deprecations
+  color: 9ae7ea
+- name: style
+  description: Style
+  color: c120e5
+- name: testing
+  description: Pull request that adds tests
+  color: b1fc6f
+- name: wontfix
+  description: This will not be worked on
+  color: ffffff

habiticalib-0.1.0/.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.0/.github/workflows/build.yml

@@ -0,0 +1,86 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python_version: ['3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python_version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+        hatch env create
+    - name: Lint and typecheck
+      run: |
+        hatch run lint-check
+    - name: Test
+      run: |
+        hatch run test-cov-xml
+    - uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: true
+        verbose: true
+
+  release:
+    runs-on: ubuntu-latest
+    environment: release
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/')
+    permissions:
+        contents: write
+        id-token: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - name: Install dependencies
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+    - name: mint API token
+      id: mint-token
+      run: |
+        # retrieve the ambient OIDC token
+        resp=$(curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \
+        "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=pypi")
+        oidc_token=$(jq -r '.value' <<< "${resp}")
+
+        # exchange the OIDC token for an API token
+        resp=$(curl -X POST https://pypi.org/_/oidc/mint-token -d "{\"token\": \"${oidc_token}\"}")
+        api_token=$(jq -r '.token' <<< "${resp}")
+
+        # mask the newly minted API token, so that we don't accidentally leak it
+        echo "::add-mask::${api_token}"
+
+        # see the next step in the workflow for an example of using this step output
+        echo "api-token=${api_token}" >> "${GITHUB_OUTPUT}"
+    - name: Build and publish on PyPI
+      env:
+        HATCH_INDEX_USER: __token__
+        HATCH_INDEX_AUTH: ${{ steps.mint-token.outputs.api-token }}
+      run: |
+        hatch build
+        hatch publish
+    - name: Create release
+      uses: ncipollo/release-action@v1
+      with:
+        draft: true
+        body: ${{ github.event.head_commit.message }}
+        artifacts: dist/*.whl,dist/*.tar.gz
+        token: ${{ secrets.GITHUB_TOKEN }}

habiticalib-0.1.0/.github/workflows/documentation.yml

@@ -0,0 +1,56 @@
+name: Build documentation
+
+on:
+  push:
+    branches:
+      - main
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+        hatch env create
+    - name: Build
+      run: hatch run docs-build
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: ./site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

habiticalib-0.1.0/.github/workflows/draft.yml

@@ -0,0 +1,19 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  update-draft:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "main"
+      - uses: release-drafter/release-drafter@v6
+        with:
+          disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

habiticalib-0.1.0/.github/workflows/labeler.yml

@@ -0,0 +1,25 @@
+name: Labeler
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+  pull-requests: write
+
+jobs:
+  labeler:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Run Labeler
+        uses: crazy-max/ghaction-github-labeler@v5.0.0
+        with:
+          skip-delete: true

habiticalib-0.1.0/.gitignore

@@ -0,0 +1,113 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+junit/
+junit.xml
+test.db
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# OS files
+.DS_Store
+
+
+# Avatar test image
+avatar.png

habiticalib-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+  - id: trailing-whitespace
+  - id: check-added-large-files
+  - id: check-merge-conflict
+  - id: check-shebang-scripts-are-executable
+  - id: check-docstring-first
+  - id: debug-statements
+  - id: check-ast
+  - id: check-json
+  - id: check-toml
+  - id: check-xml
+  - id: check-yaml
+    args: ['--unsafe']  # needed for !! tags in mkdocs.yml
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+    args: ['--fix=auto']  # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
+
+# Ruff replaces black, flake8, autoflake, isort and more
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: 'v0.7.0'  # make sure this is always consistent with hatch configs
+  hooks:
+    - id: ruff
+    - id: ruff-format
+      args: [--check, --config, ./pyproject.toml]
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: 'v1.12.0'  # make sure this is always consistent with hatch configs
+  hooks:
+    - id: mypy
+      args: ["--install-types", "--non-interactive", "--ignore-missing-imports"]
+      additional_dependencies: [types-tabulate, types-cachetools]

habiticalib-0.1.0/.vscode/settings.json

@@ -0,0 +1,22 @@
+{
+    "python.analysis.typeCheckingMode": "basic",
+    "python.analysis.autoImportCompletions": true,
+    "python.terminal.activateEnvironment": true,
+    "python.terminal.activateEnvInCurrentTerminal": true,
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "editor.rulers": [88],
+    "python.defaultInterpreterPath": "${workspaceFolder}/.hatch/habitica/bin/python",
+    "python.testing.pytestPath": "${workspaceFolder}/.hatch/habitica/bin/pytest",
+    "python.testing.cwd": "${workspaceFolder}",
+    "python.testing.pytestArgs": ["--no-cov"],
+    "[python]": {
+      "editor.formatOnSave": true,
+      "editor.codeActionsOnSave": {
+        "source.fixAll": "explicit",
+        "source.organizeImports": "explicit"
+      },
+      "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "pylint.enabled": false
+  }

habiticalib-0.1.0/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.
+

habiticalib-0.1.0/PKG-INFO

@@ -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.