oocone 0.1__py3-none-any.whl

oocone/__init__.py

@@ -0,0 +1,11 @@
+"""
+oocone
+
+Unofficial library for interacting with an enocoo energy management system
+:author: Simon Leiner <simon@leiner.me>
+:license: ISC
+"""
+
+from .enocoo import Auth, Enocoo
+
+__all__ = ["Auth", "Enocoo"]

oocone/_internal/__init__.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+def func(path: Path) -> str:
+    return str(path)

oocone/enocoo.py

@@ -0,0 +1,136 @@
+from __future__ import annotations
+
+import logging
+from typing import Any, Literal
+
+import aiohttp
+from bs4 import BeautifulSoup
+
+from oocone import errors
+from oocone.types import UNKNOWN, TrafficLightColor, TrafficLightStatus
+
+ROUTE_LOGIN = "/signinForm.php?mode=ok"
+BEAUTIFULSOUP_PARSER = "html.parser"
+
+logger = logging.getLogger(__name__)
+
+
+class Auth:
+    def __init__(
+        self,
+        *,
+        websession: aiohttp.ClientSession | None = None,
+        base_url: str,
+        username: str,
+        password: str,
+    ):
+        self._base_url = base_url.rstrip("/")
+        self.__username = username
+        self.__password = password
+        self._session = websession or aiohttp.ClientSession()
+        self._logged_in = False
+
+    @staticmethod
+    def response_indicates_not_logged_in(response: BeautifulSoup) -> bool:
+        return response.find("input", {"type": "password"}) is not None
+
+    async def _login(self) -> None:
+        async with self._session.post(
+            self._base_url + ROUTE_LOGIN,
+            data={"user": self.__username, "passwort": self.__password},
+        ) as response:
+            response_text = await response.text()
+
+            soup = BeautifulSoup(response_text, features=BEAUTIFULSOUP_PARSER)
+            if self.response_indicates_not_logged_in(soup):
+                raise errors.AuthenticationFailed
+
+    async def _request(
+        self, method: str, path: str, retry_with_login: bool = True, **kwargs
+    ) -> (aiohttp.ClientResponse, BeautifulSoup):
+        """Make a request."""
+
+        response = await self._session.request(
+            method,
+            f"{self._base_url}/{path}",
+            **kwargs,
+        )
+        soup = BeautifulSoup(await response.text(), BEAUTIFULSOUP_PARSER)
+
+        if self.response_indicates_not_logged_in(soup):
+            if retry_with_login:
+                self._login()
+                return await self._request(method=method, retry_with_login=False, **kwargs)
+            else:
+                raise errors.AuthenticationFailed()
+        else:
+            return (response, soup)
+
+
+class Enocoo:
+    """Provides access to the data accessible via the enocoo Web interface"""
+
+    def __init__(self, auth: Auth):
+        """Initialize the API and store the auth so we can make requests."""
+        self.auth = auth
+
+    @staticmethod
+    def __extract_key_from_response(response_data: dict[str, Any], key: str) -> Any:
+        try:
+            result = response_data[key]
+        except KeyError:
+            raise KeyError(
+                f'API response does not contain key "{key}".\n'
+                f"Response data:\n"
+                f"{response_data}"
+            ) from None
+
+        return result
+
+    async def get_traffic_light_status(self):
+        response, _ = await self.auth._request("GET", "php/getTrafficLightStatus.php")
+
+        try:
+            # We parse the response as JSON, even though the Content-Type header might indicate
+            # otherwise.
+            response_data = await response.json(content_type=None)
+        except Exception as e:
+            raise errors.UnexpectedResponse() from e
+
+        def parse_color(response_data: dict) -> TrafficLightColor | Literal[UNKNOWN]:
+            try:
+                raw = self.__extract_key_from_response(response_data, "color")
+            except KeyError as e:
+                logger.warning(e)
+                return UNKNOWN
+
+            if raw == "rot":
+                return TrafficLightColor.RED
+            if raw == "gelb":
+                return TrafficLightColor.YELLOW
+            if raw == r"grün":
+                return TrafficLightColor.GREEN
+
+            logger.warning(f'Got unexpected color: "{raw}"')
+            return UNKNOWN
+
+        def parse_current_energy_price(response_data: dict) -> float | Literal[UNKNOWN]:
+            try:
+                raw = self.__extract_key_from_response(response_data, "currentEnergyprice")
+            except KeyError as e:
+                logger.warning(e)
+                return UNKNOWN
+
+            try:
+                result = float(raw)
+            except Exception:
+                logger.warning("Could not parse energy price %s as a number")
+                return UNKNOWN
+
+            return result
+
+        result = TrafficLightStatus(
+            color=parse_color(response_data),
+            current_energy_price=parse_current_energy_price(response_data),
+        )
+        return result

oocone/errors.py

@@ -0,0 +1,10 @@
+class OoconeError(Exception):
+    """Base class for oocone."""
+
+
+class AuthenticationFailed(OoconeError):
+    """Authentication has failed."""
+
+
+class UnexpectedResponse(OoconeError):
+    """Got unexpected data back from the enocoo website"""

oocone/types.py

@@ -0,0 +1,20 @@
+"""Types for library users"""
+
+import enum
+from dataclasses import dataclass
+from typing import Literal
+
+
+class TrafficLightColor(enum.StrEnum):
+    RED = enum.auto()
+    YELLOW = enum.auto()
+    GREEN = enum.auto()
+
+
+UNKNOWN = "UNKNOWN"
+
+
+@dataclass
+class TrafficLightStatus:
+    color: TrafficLightColor | Literal[UNKNOWN]
+    current_energy_price: float | Literal[UNKNOWN]

oocone-0.1.dist-info/METADATA

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: oocone
+Version: 0.1
+Summary: Unofficial library for interacting with an enocoo energy management system
+Author-Email: Simon Leiner <simon@leiner.me>
+License: ISC
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Project-URL: Repository, https://github.com/sleiner/oocone
+Project-URL: Homepage, https://github.com/sleiner/oocone
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.9.4
+Requires-Dist: beautifulsoup4>=4.12.3
+Description-Content-Type: text/markdown
+
+# oocone
+
+[![Tests](https://github.com/sleiner/oocone/workflows/Tests/badge.svg)](https://github.com/sleiner/oocone/actions?query=workflow%3Aci)
+[![pypi version](https://img.shields.io/pypi/v/oocone.svg)](https://pypi.org/project/oocone/)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://astral.sh/ruff)
+[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)
+
+Unofficial library for interacting with an enocoo energy management system
+
+## Requirements
+
+oocone requires Python >= 3.11.

oocone-0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+oocone-0.1.dist-info/METADATA,sha256=LJCfIGE_R7PGIBNcs-VRyV86VdVy7aFFcRB8vzSiWVM,1094
+oocone-0.1.dist-info/WHEEL,sha256=SOP-4bEE0jbVaCHQGVvF08uWxk5rcSsfEybvoQVHlD8,90
+oocone-0.1.dist-info/licenses/LICENSE,sha256=kyCZ7TTrgf3ZCI2_jqFIpG-t-NEWdnFeZ5Z6hUNLD4w,736
+oocone/__init__.py,sha256=B0DC-jVCF3fy59FfQ7l86S6_-iWH3iXqxmU76hSEyKk,209
+oocone/_internal/__init__.py,sha256=iQJYMCGQBBcftPVBoluljC3g-gFEUh7k5Zdx7VXRpwE,169
+oocone/_internal/api_types.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oocone/enocoo.py,sha256=RD9XfRbgkJJOqTzHgGs2LCv_KyHwwI6-mLx6j850L4A,4452
+oocone/errors.py,sha256=2cQvR5JIGgLC5Z8jGT4VeZt1f9Yxx708TvLW5Uc84nI,243
+oocone/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oocone/types.py,sha256=rlMCRC9T_AXROvaK40R74uCePI4OE4kaSvIqhDaIeU4,376
+oocone-0.1.dist-info/RECORD,,

oocone-0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.3.1)
+Root-Is-Purelib: true
+Tag: py3-none-any

oocone-0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,15 @@
+ISC
+
+Copyright (c) 2024, Simon Leiner
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.