aiopapouch 0.0.1__tar.gz

aiopapouch-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+        
+    - name: Install build tool
+      run: python -m pip install --upgrade pip build
+      
+    - name: Build package
+      run: python -m build
+      
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

aiopapouch-0.0.1/.gitignore

@@ -0,0 +1,218 @@
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

aiopapouch-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Levad
+
+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.

aiopapouch-0.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.5
+Name: aiopapouch
+Version: 0.0.1
+Summary: API client and device models for Papouch's devices
+Project-URL: Source, https://github.com/VladislavLevitskii/aiopapouch
+Author-email: VladislavLevitskii <vladlevitskii@gmail.com>
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.0.0
+Requires-Dist: defusedxml>=0.7.1
+Description-Content-Type: text/markdown
+
+# aiopapouch
+
+This repository contains an asynchronous Python I/O library for Papouch s.r.o. devices.
+
+The library provides two major components: **Devices** and **API Client** for communication with the hardware.
+
+## Requirements
+
+* **Python 3.14+**: The library requires Python 3.14 or higher (PEP 758).
+* **aiohttp**: Required for handling asynchronous HTTP communication with the devices.
+
+## Installation
+
+```bash
+pip install aiopapouch
+
+```
+
+## Supported Devices
+
+Currently, the library supports the following Ethernet devices communicating via WEB mode:
+
+* Quido ETH
+* Papago 
+    * Meteo
+    * 2TH
+    * 5HDI DO
+    * TH 2DI DO
+* TH2E
+* TME
+* TME Multi / Radio
+
+## Devices
+
+The library is designed using an object-oriented approach. Every device (or device family) is a subclass of `PapouchDevice`, which provides contract methods such as `parse_fresh_data`, `get_supported_sensors`, and properties like `name` and `location`. The `base.py` file also includes mixins (primarily for HTTP communication), as various network devices share the same functions. Creating an additional layer between `PapouchDevice` and the final subclasses is unnecessary since only a specific subset of functions needs to be included.
+
+Due to polymorphism, the `create_device` function returns an abstract `PapouchDevice`. It works in tandem with the `is_device_supported` function, which validates whether the hardware is supported by this library.
+
+> ***Note:*** The constructors are asynchronous (implementing the factory pattern). Creating any device instance utilizes the network to download the initial configuration.
+
+> ***Note:*** The library was designed specifically for Home Assistant. Methods like `get_supported_sensors` return configurations required for entity creation in Home Assistant. This remains the primary purpose of the library.
+
+> ***Note:*** Initial fresh fetch of data happens before the creation of the entities, making it a valid approach to generate configurations during the parsing of fresh data.
+
+## API Client
+
+The API Client follows a similar architecture. There is an abstract base class `PapouchTransport` that defines the contract methods for subclasses, such as `fetch_info`, `read_command`, and `write_command`.
+
+Currently, there is one subclass, `PapouchHTTPClient`, which fulfills this contract and handles network communication over HTTP.
+
+## Exceptions
+
+The library defines custom exceptions raised during execution. These exceptions are designed to be caught and handled within the Home Assistant integration.
+
+## Usage
+
+Although `aiopapouch` is primarily designed to serve as the underlying library for the official Home Assistant Papouch integration, it can also be used independently in standalone Python scripts.
+
+The following example illustrates how to create a client, instantiate a device, fetch raw telemetry data, and pass it to `parse_fresh_data`:
+
+```python
+import asyncio
+import aiohttp
+from aiopapouch import PapouchHTTPClient, create_device
+
+async def main():
+    # Initialize the aiohttp client session
+    async with aiohttp.ClientSession() as session:
+        # Initialize the API transport client
+        client = PapouchHTTPClient("192.168.1.100", session)
+        
+        # Create the device
+        device = await create_device(client)
+        
+        if device is None:
+            print("Device not supported or connection failed.")
+            return
+
+        print(f"Connected to: {device.name} at {device.location}")
+
+        # Fetch raw fresh XML data from the device
+        raw_fresh_xml = await client.fetch_data()
+
+        # Parse fresh data to update device state and return processed readings
+        parsed_data = await device.parse_fresh_data(raw_fresh_xml)
+        print("Parsed telemetry data:", parsed_data)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+```
+
+## Future Extensions
+
+Papouch manufactures not only network-based devices but also serial ones (e.g., using RS485). Future extensions will include a new serial transport subclass implementing `PapouchTransport`, alongside new `PapouchDevice` subclasses designed specifically for serial communication protocols.

aiopapouch-0.0.1/README.md

@@ -0,0 +1,95 @@
+# aiopapouch
+
+This repository contains an asynchronous Python I/O library for Papouch s.r.o. devices.
+
+The library provides two major components: **Devices** and **API Client** for communication with the hardware.
+
+## Requirements
+
+* **Python 3.14+**: The library requires Python 3.14 or higher (PEP 758).
+* **aiohttp**: Required for handling asynchronous HTTP communication with the devices.
+
+## Installation
+
+```bash
+pip install aiopapouch
+
+```
+
+## Supported Devices
+
+Currently, the library supports the following Ethernet devices communicating via WEB mode:
+
+* Quido ETH
+* Papago 
+    * Meteo
+    * 2TH
+    * 5HDI DO
+    * TH 2DI DO
+* TH2E
+* TME
+* TME Multi / Radio
+
+## Devices
+
+The library is designed using an object-oriented approach. Every device (or device family) is a subclass of `PapouchDevice`, which provides contract methods such as `parse_fresh_data`, `get_supported_sensors`, and properties like `name` and `location`. The `base.py` file also includes mixins (primarily for HTTP communication), as various network devices share the same functions. Creating an additional layer between `PapouchDevice` and the final subclasses is unnecessary since only a specific subset of functions needs to be included.
+
+Due to polymorphism, the `create_device` function returns an abstract `PapouchDevice`. It works in tandem with the `is_device_supported` function, which validates whether the hardware is supported by this library.
+
+> ***Note:*** The constructors are asynchronous (implementing the factory pattern). Creating any device instance utilizes the network to download the initial configuration.
+
+> ***Note:*** The library was designed specifically for Home Assistant. Methods like `get_supported_sensors` return configurations required for entity creation in Home Assistant. This remains the primary purpose of the library.
+
+> ***Note:*** Initial fresh fetch of data happens before the creation of the entities, making it a valid approach to generate configurations during the parsing of fresh data.
+
+## API Client
+
+The API Client follows a similar architecture. There is an abstract base class `PapouchTransport` that defines the contract methods for subclasses, such as `fetch_info`, `read_command`, and `write_command`.
+
+Currently, there is one subclass, `PapouchHTTPClient`, which fulfills this contract and handles network communication over HTTP.
+
+## Exceptions
+
+The library defines custom exceptions raised during execution. These exceptions are designed to be caught and handled within the Home Assistant integration.
+
+## Usage
+
+Although `aiopapouch` is primarily designed to serve as the underlying library for the official Home Assistant Papouch integration, it can also be used independently in standalone Python scripts.
+
+The following example illustrates how to create a client, instantiate a device, fetch raw telemetry data, and pass it to `parse_fresh_data`:
+
+```python
+import asyncio
+import aiohttp
+from aiopapouch import PapouchHTTPClient, create_device
+
+async def main():
+    # Initialize the aiohttp client session
+    async with aiohttp.ClientSession() as session:
+        # Initialize the API transport client
+        client = PapouchHTTPClient("192.168.1.100", session)
+        
+        # Create the device
+        device = await create_device(client)
+        
+        if device is None:
+            print("Device not supported or connection failed.")
+            return
+
+        print(f"Connected to: {device.name} at {device.location}")
+
+        # Fetch raw fresh XML data from the device
+        raw_fresh_xml = await client.fetch_data()
+
+        # Parse fresh data to update device state and return processed readings
+        parsed_data = await device.parse_fresh_data(raw_fresh_xml)
+        print("Parsed telemetry data:", parsed_data)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+```
+
+## Future Extensions
+
+Papouch manufactures not only network-based devices but also serial ones (e.g., using RS485). Future extensions will include a new serial transport subclass implementing `PapouchTransport`, alongside new `PapouchDevice` subclasses designed specifically for serial communication protocols.

aiopapouch-0.0.1/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "aiopapouch"
+version = "0.0.1"
+description = "API client and device models for Papouch's devices"
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "MIT" }
+authors = [
+    { name = "VladislavLevitskii", email = "vladlevitskii@gmail.com" }
+]
+dependencies = [
+    "aiohttp>=3.0.0",
+    "defusedxml>=0.7.1"
+]
+
+[project.urls]
+Source = "https://github.com/VladislavLevitskii/aiopapouch"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/aiopapouch"]

aiopapouch-0.0.1/src/aiopapouch/__init__.py

@@ -0,0 +1,12 @@
+"""This file is used as a hub for imports."""
+
+from .client import PapouchHTTPClient, PapouchTransport
+from .devices import PapouchDevice, create_device, is_device_supported
+
+__all__ = [
+    "PapouchDevice",
+    "PapouchHTTPClient",
+    "PapouchTransport",
+    "create_device",
+    "is_device_supported",
+]