aioetatouch 0.1.0__tar.gz

aioetatouch-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Sync dependencies
+        run: uv sync --python ${{ matrix.python-version }}
+
+      - name: Ruff check
+        run: uv run ruff check .
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Mypy
+        run: uv run mypy
+
+      - name: Pytest
+        run: uv run pytest --cov --cov-report=term-missing

aioetatouch-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Sync dependencies
+        run: uv sync
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Verify package version matches release tag
+        run: |
+          PKG_VERSION="$(uv run python -c 'import aioetatouch; print(aioetatouch.__version__)')"
+          TAG="${{ github.event.release.tag_name }}"
+          if [ "$PKG_VERSION" != "$TAG" ]; then
+            echo "::error::Package version ($PKG_VERSION) does not match release tag ($TAG)"
+            exit 1
+          fi
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

aioetatouch-0.1.0/.github/workflows/release-please.yml

@@ -0,0 +1,16 @@
+name: Release Please
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+          config-file: .release-please-config.json
+          manifest-file: .release-please-manifest.json

aioetatouch-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+.superpowers/
+
+__pycache__/
+.venv/
+dist/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.egg-info/
+.coverage
+.coverage.*
+htmlcov/

aioetatouch-0.1.0/.release-please-config.json

@@ -0,0 +1,11 @@
+{
+  "release-type": "python",
+  "include-v-in-tag": false,
+  "packages": {
+    ".": {
+      "extra-files": [
+        "src/aioetatouch/__init__.py"
+      ]
+    }
+  }
+}

aioetatouch-0.1.0/.release-please-manifest.json

@@ -0,0 +1 @@
+{".":"0.1.0"}

aioetatouch-0.1.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0 (2026-07-19)
+
+
+### Documentation
+
+* clarify read-only scope and expand README for PyPI ([86665fe](https://github.com/g4bri3lDev/aioetatouch/commit/86665fe249fcaacecb9c439fdbe9199d429bac98))

aioetatouch-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing
+      the origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 g4bri3lDev
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

aioetatouch-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: aioetatouch
+Version: 0.1.0
+Summary: Async Python client for the ETAtouch REST API of ETA heating systems
+Author-email: g4bri3lDev <admin@g4bri3l.de>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.9
+Provides-Extra: cli
+Requires-Dist: rich>=13; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# aioetatouch
+
+Async Python client for the ETAtouch REST API of ETA heating systems.
+
+This project is a work in progress. The API surface is not yet stable.
+
+Requires Python >=3.12.
+
+## Install
+
+```bash
+pip install aioetatouch
+```
+
+## Usage
+
+The caller owns the `aiohttp.ClientSession` (the Home Assistant convention);
+`EtaClient` never creates or closes it.
+
+```python
+import asyncio
+
+import aiohttp
+
+from aioetatouch import EtaClient
+
+
+async def main() -> None:
+    async with aiohttp.ClientSession() as session:
+        client = EtaClient("192.168.1.50", session)
+
+        tree = await client.get_menu()
+        for node in tree:
+            print(node.uri, node.name)
+
+        value = await client.get_var("/120/10101/0/0/12197")
+        print(f"{value.scaled} {value.unit}")
+
+
+asyncio.run(main())
+```
+
+### Read-only, with one caveat
+
+`EtaClient` is read-only with respect to variable *values* -- there is no
+method to write a heater's setpoint or state. The one exception is the
+`create_set` / `delete_set` / `add_to_set` / `remove_from_set` methods, which
+intentionally mutate the device's web-service variable-set containers
+(required for bulk polling); they never touch a heater value.
+
+### Errors
+
+All exceptions inherit from `EtaError`:
+
+- `EtaParseError` -- an ETAtouch XML response could not be parsed.
+- `EtaConnectionError` -- the device could not be reached (transport
+  failure or timeout).
+- `EtaApiError` -- the device returned a non-2xx HTTP response; carries
+  `status` and `message`.
+
+## CLI
+
+An optional recon/debugging CLI is available via `pip install aioetatouch[cli]`:
+
+```bash
+aioetatouch --host 192.168.1.50 menu
+aioetatouch --host 192.168.1.50 var /120/10101/0/0/12197
+```

aioetatouch-0.1.0/README.md

@@ -0,0 +1,68 @@
+# aioetatouch
+
+Async Python client for the ETAtouch REST API of ETA heating systems.
+
+This project is a work in progress. The API surface is not yet stable.
+
+Requires Python >=3.12.
+
+## Install
+
+```bash
+pip install aioetatouch
+```
+
+## Usage
+
+The caller owns the `aiohttp.ClientSession` (the Home Assistant convention);
+`EtaClient` never creates or closes it.
+
+```python
+import asyncio
+
+import aiohttp
+
+from aioetatouch import EtaClient
+
+
+async def main() -> None:
+    async with aiohttp.ClientSession() as session:
+        client = EtaClient("192.168.1.50", session)
+
+        tree = await client.get_menu()
+        for node in tree:
+            print(node.uri, node.name)
+
+        value = await client.get_var("/120/10101/0/0/12197")
+        print(f"{value.scaled} {value.unit}")
+
+
+asyncio.run(main())
+```
+
+### Read-only, with one caveat
+
+`EtaClient` is read-only with respect to variable *values* -- there is no
+method to write a heater's setpoint or state. The one exception is the
+`create_set` / `delete_set` / `add_to_set` / `remove_from_set` methods, which
+intentionally mutate the device's web-service variable-set containers
+(required for bulk polling); they never touch a heater value.
+
+### Errors
+
+All exceptions inherit from `EtaError`:
+
+- `EtaParseError` -- an ETAtouch XML response could not be parsed.
+- `EtaConnectionError` -- the device could not be reached (transport
+  failure or timeout).
+- `EtaApiError` -- the device returned a non-2xx HTTP response; carries
+  `status` and `message`.
+
+## CLI
+
+An optional recon/debugging CLI is available via `pip install aioetatouch[cli]`:
+
+```bash
+aioetatouch --host 192.168.1.50 menu
+aioetatouch --host 192.168.1.50 var /120/10101/0/0/12197
+```

aioetatouch-0.1.0/RELEASING.md

@@ -0,0 +1,65 @@
+# Releasing
+
+Releases are automated with [release-please](https://github.com/googleapis/release-please) and
+published to PyPI via [trusted publishing](https://docs.pypi.org/trusted-publishers/) (no API
+tokens stored anywhere).
+
+## Conventional Commits
+
+Every commit on `main` must follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+- `feat: ...` -> minor version bump
+- `fix: ...` -> patch version bump
+- `feat!: ...` / `fix!: ...` / a `BREAKING CHANGE:` footer -> major version bump
+- `chore:`, `docs:`, `refactor:`, `test:`, `ci:`, etc. -> no version bump (still recorded, but not
+  released on their own)
+
+release-please parses commit history since the last release to determine the next version and to
+generate the changelog. It does not read this repo's changelog by hand — `CHANGELOG.md` is
+entirely owned and written by release-please; do not hand-edit it.
+
+## Release flow
+
+1. Commits land on `main` via Conventional Commits.
+2. The `Release Please` workflow (`.github/workflows/release-please.yml`) runs on every push to
+   `main`. It opens/updates a "release PR" that bumps the version (in
+   `src/aioetatouch/__init__.py`, the single source of truth per the `x-release-please-version`
+   annotation) and accumulates the changelog.
+3. Merging the release PR makes release-please tag the commit (tag format `X.Y.Z`, no `v` prefix
+   per `include-v-in-tag: false`) and create a GitHub Release.
+4. The GitHub Release publish event triggers `.github/workflows/publish.yml`:
+   - `build` job: checks out the release tag, runs `uv sync` + `uv run pytest` as a sanity check,
+     verifies `aioetatouch.__version__` matches the release tag exactly, then `uv build`s the
+     sdist/wheel and uploads them as a workflow artifact.
+   - `publish` job: downloads the artifact and publishes it to PyPI with
+     `pypa/gh-action-pypi-publish`, authenticating via OIDC trusted publishing under the `pypi`
+     GitHub environment. No secrets are configured or required.
+
+## First release (0.1.0) bootstrap
+
+`aioetatouch` has not been released yet, so there is no prior tag for release-please to diff
+against. Once the repository is pushed to GitHub, bootstrap the first release with an empty commit
+carrying a `Release-As` footer:
+
+```bash
+git commit --allow-empty -m "chore: release 0.1.0" -m "Release-As: 0.1.0"
+git push origin main
+```
+
+This is a one-time manual step; do not perform it as part of routine release automation setup.
+release-please will pick up the `Release-As` footer, open the 0.1.0 release PR, and normal
+automation takes over from there.
+
+## One-time manual setup (do before the first release)
+
+1. **Create the `pypi` GitHub environment**: repo Settings -> Environments -> New environment ->
+   name it `pypi`. (Optionally add protection rules, e.g. required reviewers.)
+2. **Register a PyPI trusted publisher** for this project (on PyPI, under the project's
+   "Publishing" settings, or via the pending-publisher flow if the project does not exist yet):
+   - Owner: `g4bri3lDev`
+   - Repository name: `aioetatouch`
+   - Workflow name: `publish.yml`
+   - Environment name: `pypi`
+
+No PyPI API token is created or stored — publishing is authorized purely via GitHub Actions OIDC
+matching the trusted publisher configuration above.

aioetatouch-0.1.0/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "aioetatouch"
+dynamic = ["version"]
+description = "Async Python client for the ETAtouch REST API of ETA heating systems"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.12"
+authors = [
+    { name = "g4bri3lDev", email = "admin@g4bri3l.de" },
+]
+dependencies = [
+    "aiohttp>=3.9",
+]
+
+[project.optional-dependencies]
+cli = ["rich>=13"]
+
+[project.scripts]
+aioetatouch = "aioetatouch.cli:main"
+
+[dependency-groups]
+dev = [
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "ruff",
+    "mypy",
+    "rich>=13",
+]
+
+[tool.hatch.version]
+path = "src/aioetatouch/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/aioetatouch"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.mypy]
+strict = true
+files = "src"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["src/aioetatouch"]
+branch = true
+# __main__.py is a trivial `python -m aioetatouch` shim (import + `raise
+# SystemExit(main())`); it is only ever exercised by launching a subprocess,
+# which isn't worth the cost for a one-liner, so it's omitted rather than
+# unit tested or peppered with pragmas.
+omit = ["src/aioetatouch/__main__.py"]
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true

aioetatouch-0.1.0/src/aioetatouch/__init__.py

@@ -0,0 +1,51 @@
+"""Async Python client for the ETAtouch REST API of ETA heating systems."""
+
+from __future__ import annotations
+
+from .client import EtaClient
+from .exceptions import EtaApiError, EtaConnectionError, EtaError, EtaParseError
+from .models import (
+    Envelope,
+    ErrorEntry,
+    MenuNode,
+    MenuTree,
+    Value,
+    VarInfo,
+    VarType,
+)
+from .parser import (
+    parse_api_version,
+    parse_envelope,
+    parse_errors,
+    parse_menu,
+    parse_value,
+    parse_varinfo,
+    parse_vars_list,
+    parse_vars_set,
+)
+
+__version__ = "0.1.0"  # x-release-please-version
+
+__all__ = [
+    "Envelope",
+    "ErrorEntry",
+    "EtaApiError",
+    "EtaClient",
+    "EtaConnectionError",
+    "EtaError",
+    "EtaParseError",
+    "MenuNode",
+    "MenuTree",
+    "Value",
+    "VarInfo",
+    "VarType",
+    "__version__",
+    "parse_api_version",
+    "parse_envelope",
+    "parse_errors",
+    "parse_menu",
+    "parse_value",
+    "parse_varinfo",
+    "parse_vars_list",
+    "parse_vars_set",
+]