mielelogic-api 1.0.0__tar.gz

mielelogic_api-1.0.0/.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{sh,bash,json,toml,yml,yaml}]
+indent_size = 2
+
+[LICENSE]
+indent_style = unset
+indent_size = unset
+trim_trailing_whitespace = unset

mielelogic_api-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Sync environment
+        run: uv sync --all-groups --frozen
+
+      - name: Run test suite
+        run: uv run poe test-ci

mielelogic_api-1.0.0/.github/workflows/lint.yml

@@ -0,0 +1,44 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ruff:
+    name: Ruff
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Sync environment
+        run: uv sync --all-groups --frozen
+
+      - name: Lint
+        run: uv run poe lint
+
+      - name: Check formatting
+        run: uv run poe format-check

mielelogic_api-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,60 @@
+name: Publish PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: read
+  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: pypi
+      url: https://pypi.org/project/mielelogic-api/
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-dist
+          path: dist/
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

mielelogic_api-1.0.0/.github/workflows/validate.yml

@@ -0,0 +1,40 @@
+name: Validate
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  hassfest:
+    name: Hassfest validation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v6
+
+      - name: Run hassfest validation
+        uses: home-assistant/actions/hassfest@master
+
+  hacs:
+    name: HACS validation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run HACS validation
+        uses: hacs/action@main
+        with:
+          category: integration
+          ignore: brands

mielelogic_api-1.0.0/.gitignore

@@ -0,0 +1,223 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Home Assistant dev config
+.ha-dev-config/
+.ha-dev-venv/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Snapshot directory
+snapshots/

mielelogic_api-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+# See https://pre-commit.com for more information
+default_language_version:
+  python: python3
+fail_fast: false
+
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-lint
+        name: ruff lint
+        entry: ruff check
+        language: system
+        types: [python]
+        args: [--fix]
+
+      - id: ruff-format
+        name: ruff format
+        entry: ruff format
+        language: system
+        types: [python]
+
+      - id: pytest
+        name: pytest
+        entry: pytest
+        language: system
+        types: [python]
+        pass_filenames: false
+        args: [tests]
+
+      - id: editorconfig-checker
+        name: editorconfig-checker
+        entry: ec
+        language: system
+        types: [text]

mielelogic_api-1.0.0/.python-version

@@ -0,0 +1 @@
+3.13

mielelogic_api-1.0.0/AGENTS.md

@@ -0,0 +1,90 @@
+# AGENTS.md
+
+## Project summary
+
+This repository contains two related but separate Python code areas in one uv project:
+
+1. `mielelogic_api/` The standalone async MieleLogic API client library.
+2. `custom_components/mielelogic/` The Home Assistant custom integration that uses the client library.
+
+Keep these concerns separated in code structure, even though the development environment is shared.
+
+## Environment usage
+
+- For agent execution, prefer `uv run ...` for Python-related commands instead of shell activation.
+- Do not write `uv run ...` in user-facing documentation or examples unless the task explicitly asks for it.
+- User-facing documentation should assume an activated environment via `source .venv/bin/activate` or `source .envrc`, then show commands without the `uv run` prefix.
+- Use `uv sync` only when dependencies or dependency groups changed, or when the environment is inconsistent.
+- Do not add extra wrapper env vars or command flags unless there is a concrete reason.
+
+## `uv sync`
+
+- Use `uv sync` when dependencies or dependency groups changed, or when the environment is inconsistent with `pyproject.toml` / `uv.lock`.
+- Run it from the repo root.
+- Do not use `uv sync` casually before every command.
+
+## Poe usage
+
+- For agent execution, prefer Poe through `uv run`.
+- In user-facing docs, assume the environment is already activated and show plain `poe ...` commands.
+
+- `poe test` is for the library and CLI tests only. It runs as `pytest tests/mielelogic_cli tests/mielelogic_api` in the shared `.venv`.
+- `poe test-ha` is for Home Assistant integration tests only. It runs as `pytest tests/custom_components/mielelogic` in the shared `.venv`.
+- `poe test-network` is for the opt-in live API tests marked with `@pytest.mark.network`.
+
+## Verification
+
+- After changing code, run the relevant test suite, possibly limiting to tests touching the changes you have made, before considering the work done.
+- For root library changes, run:
+
+```bash
+poe test  # pytest tests/mielelogic_cli tests/mielelogic_api
+```
+
+- For Home Assistant integration changes, run:
+
+```bash
+poe test-ha  # pytest tests/custom_components/mielelogic
+```
+
+- For changes that affect both layers, run:
+
+```bash
+poe test-all  # sequence running `poe test` then `poe test-ha`
+```
+
+- Run lint, then tests, then format. Do not run tests a second time if the format changes anything. We trust that ruff does not change behaviour.
+
+## Root vs HA test separation
+
+- The root library code and the Home Assistant integration remain separate code areas.
+- The shared `.venv` includes both the root dev tools and the HA test stack.
+- Keep the test entrypoints separate: `poe test` for `tests/mielelogic_cli` and `tests/mielelogic_api`, `poe test-ha` for `tests/custom_components/mielelogic`.
+
+## Networked tests
+
+- Tests marked with `@pytest.mark.network` are real live API checks and should remain marked.
+- Do not remove the marker.
+- It is acceptable for these tests to be skipped, it only validates that the external API still acts as we encode into the DTO objects and factories.
+- If live verification is needed, ask the user to run the command outside the sandbox.
+
+## Ruff / formatting
+
+Linting and formatting are minor cleanup steps. Run them once at the end, during verification, after the relevant tests pass and you are done applying changes.
+
+- Prefer Poe wrappers:
+
+```bash
+poe lint  # ruff check .
+poe lint-fix  # ruff check --fix .
+poe format  # ruff format .
+```
+
+- Do not run lint or format repeatedly while still implementing changes unless there is a concrete need.
+
+## What not to do
+
+- Do not use `PYTEST_DISABLE_PLUGIN_AUTOLOAD`.
+- Do not change DTO definitions or factory logic. These need to stay EXACTLY equivalent to the live API. This is important.
+- Do not remove or replace the existing `pydantic_settings` `.env` handling for unless the user explicitly asks for that exact change.
+- Do not change `poe` commands unless asked to do so.