switch2 0.1.0__tar.gz

switch2-0.1.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: switch2
+Version: 0.1.0
+Summary: Async client library for the Switch2 energy portal
+Author-email: Jelmer Vernooij <jelmer@jelmer.uk>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/jelmer/python-switch2
+Project-URL: Repository, https://github.com/jelmer/python-switch2
+Project-URL: Issues, https://github.com/jelmer/python-switch2/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: aiohttp>=3.8
+Requires-Dist: beautifulsoup4>=4.12
+
+# python-switch2
+
+Async Python client library for the [Switch2](https://my.switch2.co.uk) energy portal.
+
+## Installation
+
+```sh
+pip install switch2
+```
+
+## Usage
+
+```python
+import asyncio
+from switch2 import Switch2ApiClient
+
+async def main():
+    client = Switch2ApiClient("you@example.com", "your-password")
+    try:
+        data = await client.fetch_data()
+        print(f"Customer: {data.customer.name}")
+        for reading in data.readings:
+            print(f"  {reading.date}: {reading.amount} {reading.unit}")
+        for bill in data.bills:
+            print(f"  {bill.date}: £{bill.amount}")
+    finally:
+        await client.close()
+
+asyncio.run(main())
+```
+
+## License
+
+Apache-2.0

switch2-0.1.0/README.md

@@ -0,0 +1,34 @@
+# python-switch2
+
+Async Python client library for the [Switch2](https://my.switch2.co.uk) energy portal.
+
+## Installation
+
+```sh
+pip install switch2
+```
+
+## Usage
+
+```python
+import asyncio
+from switch2 import Switch2ApiClient
+
+async def main():
+    client = Switch2ApiClient("you@example.com", "your-password")
+    try:
+        data = await client.fetch_data()
+        print(f"Customer: {data.customer.name}")
+        for reading in data.readings:
+            print(f"  {reading.date}: {reading.amount} {reading.unit}")
+        for bill in data.bills:
+            print(f"  {bill.date}: £{bill.amount}")
+    finally:
+        await client.close()
+
+asyncio.run(main())
+```
+
+## License
+
+Apache-2.0

switch2-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "switch2"
+version = "0.1.0"
+description = "Async client library for the Switch2 energy portal"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+authors = [
+    { name = "Jelmer Vernooij", email = "jelmer@jelmer.uk" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Home Automation",
+    "Framework :: AsyncIO",
+]
+dependencies = [
+    "aiohttp>=3.8",
+    "beautifulsoup4>=4.12",
+]
+
+[project.urls]
+Homepage = "https://github.com/jelmer/python-switch2"
+Repository = "https://github.com/jelmer/python-switch2"
+Issues = "https://github.com/jelmer/python-switch2/issues"
+
+[tool.mypy]
+packages = ["switch2"]
+strict = true
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "W"]

switch2-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

switch2-0.1.0/switch2/__init__.py

@@ -0,0 +1,21 @@
+"""Standalone client library for the Switch2 energy portal."""
+
+from .api import (
+    Bill,
+    CustomerInfo,
+    MeterReading,
+    Switch2ApiClient,
+    Switch2AuthError,
+    Switch2ConnectionError,
+    Switch2Data,
+)
+
+__all__ = [
+    "Bill",
+    "CustomerInfo",
+    "MeterReading",
+    "Switch2ApiClient",
+    "Switch2AuthError",
+    "Switch2ConnectionError",
+    "Switch2Data",
+]

switch2-0.1.0/switch2/api.py

@@ -0,0 +1,289 @@
+"""API client for the Switch2 energy portal."""
+
+from __future__ import annotations
+
+import logging
+from dataclasses import dataclass
+from datetime import datetime
+
+import aiohttp
+from bs4 import BeautifulSoup, Tag
+
+_LOGGER = logging.getLogger(__name__)
+
+BASE_URL = "https://my.switch2.co.uk"
+LOGIN_URL = f"{BASE_URL}/Login"
+METER_HISTORY_URL = f"{BASE_URL}/MeterReadings/History"
+BILL_HISTORY_URL = f"{BASE_URL}/Credit/BillHistory"
+
+
+class Switch2AuthError(Exception):
+    """Raised when authentication fails."""
+
+
+class Switch2ConnectionError(Exception):
+    """Raised when a connection error occurs."""
+
+
+@dataclass
+class CustomerInfo:
+    """Customer information from the Switch2 portal."""
+
+    name: str
+    account_number: str
+    address: str
+
+
+@dataclass
+class MeterReading:
+    """A single meter reading."""
+
+    date: datetime
+    amount: float
+    unit: str
+    reading_type: str
+
+
+@dataclass
+class Bill:
+    """A single bill."""
+
+    date: datetime
+    amount: float
+    detail_url: str
+
+
+@dataclass
+class Switch2Data:
+    """All data fetched from the Switch2 portal."""
+
+    customer: CustomerInfo
+    readings: list[MeterReading]
+    registers: dict[str, str]  # register_id -> register_name
+    bills: list[Bill]
+
+
+def _get_attr(tag: Tag, attr: str, default: str = "") -> str:
+    """Get a string attribute from a BeautifulSoup tag, handling list values."""
+    value = tag.get(attr, default)
+    if isinstance(value, list):
+        return value[0] if value else default
+    return value
+
+
+class Switch2ApiClient:
+    """Client to interact with the Switch2 web portal."""
+
+    def __init__(self, email: str, password: str) -> None:
+        self._email = email
+        self._password = password
+        self._session: aiohttp.ClientSession | None = None
+
+    async def _ensure_session(self) -> aiohttp.ClientSession:
+        if self._session is None or self._session.closed:
+            self._session = aiohttp.ClientSession()
+        return self._session
+
+    async def close(self) -> None:
+        """Close the underlying HTTP session."""
+        if self._session and not self._session.closed:
+            await self._session.close()
+
+    async def authenticate(self) -> CustomerInfo:
+        """Log in to the Switch2 portal and return customer info."""
+        session = await self._ensure_session()
+
+        try:
+            # Step 1: GET the login page to get any CSRF tokens
+            async with session.get(LOGIN_URL) as resp:
+                if resp.status != 200:
+                    raise Switch2ConnectionError(
+                        f"Failed to load login page: HTTP {resp.status}"
+                    )
+                html = await resp.text()
+
+            soup = BeautifulSoup(html, "html.parser")
+            token_input = soup.select_one('input[name="__RequestVerificationToken"]')
+            form_data: dict[str, str] = {}
+            if token_input:
+                form_data["__RequestVerificationToken"] = _get_attr(
+                    token_input, "value"
+                )
+
+            # Step 2: POST login credentials
+            form_data["UserName"] = self._email
+            form_data["Password"] = self._password
+
+            async with session.post(
+                LOGIN_URL, data=form_data, allow_redirects=True
+            ) as resp:
+                if resp.status != 200:
+                    raise Switch2ConnectionError(
+                        f"Login request failed: HTTP {resp.status}"
+                    )
+                html = await resp.text()
+
+            soup = BeautifulSoup(html, "html.parser")
+            customer = _parse_customer_info(soup)
+            if not customer.name:
+                raise Switch2AuthError("Login failed: no customer info returned")
+
+            return customer
+
+        except aiohttp.ClientError as err:
+            raise Switch2ConnectionError(
+                f"Connection error during login: {err}"
+            ) from err
+
+    async def fetch_data(self) -> Switch2Data:
+        """Authenticate and fetch all meter data."""
+        customer = await self.authenticate()
+        session = await self._ensure_session()
+
+        try:
+            # GET meter readings history page
+            async with session.get(METER_HISTORY_URL) as resp:
+                if resp.status != 200:
+                    raise Switch2ConnectionError(
+                        f"Failed to load meter history: HTTP {resp.status}"
+                    )
+                html = await resp.text()
+
+            soup = BeautifulSoup(html, "html.parser")
+
+            # Parse available registers
+            registers: dict[str, str] = {}
+            register_select = soup.select_one("#RegisterId")
+            if register_select:
+                for option in register_select.select("option"):
+                    reg_id = option.get("value", "")
+                    if reg_id:
+                        registers[str(reg_id)] = option.text.strip()
+
+            # Try to get all readings by POSTing with a large page size
+            token_input = soup.select_one('input[name="__RequestVerificationToken"]')
+            selected_register = soup.select_one("#RegisterId option[selected]")
+
+            if token_input and selected_register:
+                form_data = {
+                    "__RequestVerificationToken": _get_attr(token_input, "value"),
+                    "Page": "1",
+                    "TotalPages": "1",
+                    "RegisterId": _get_attr(selected_register, "value"),
+                    "PageSize": "1000000",
+                }
+
+                async with session.post(
+                    METER_HISTORY_URL, data=form_data, allow_redirects=True
+                ) as resp:
+                    if resp.status == 200:
+                        html = await resp.text()
+                        soup = BeautifulSoup(html, "html.parser")
+
+            readings = _parse_readings(soup)
+
+            # Fetch bill history
+            async with session.get(BILL_HISTORY_URL) as resp:
+                if resp.status != 200:
+                    raise Switch2ConnectionError(
+                        f"Failed to load bill history: HTTP {resp.status}"
+                    )
+                html = await resp.text()
+
+            bills = _parse_bills(BeautifulSoup(html, "html.parser"))
+
+            return Switch2Data(
+                customer=customer,
+                readings=readings,
+                registers=registers,
+                bills=bills,
+            )
+
+        except aiohttp.ClientError as err:
+            raise Switch2ConnectionError(
+                f"Connection error fetching data: {err}"
+            ) from err
+
+
+def _parse_date(text: str) -> datetime:
+    """Parse a date string like '27th February 2026'."""
+    # Strip ordinal suffixes (1st, 2nd, 3rd, 4th, etc.)
+    for suffix in ("st ", "nd ", "rd ", "th "):
+        text = text.replace(suffix, " ")
+    for fmt in ("%d %B %Y", "%d %b %Y"):
+        try:
+            return datetime.strptime(text, fmt)
+        except ValueError:
+            continue
+    raise ValueError(f"Cannot parse date: {text!r}")
+
+
+def _parse_customer_info(soup: BeautifulSoup) -> CustomerInfo:
+    """Extract customer info from the dashboard page."""
+    name_el = soup.select_one(".customer-info-name")
+    acn_el = soup.select_one(".customer-info-account-number")
+    addr_el = soup.select_one(".customer-info-address")
+
+    return CustomerInfo(
+        name=name_el.text.strip() if name_el else "",
+        account_number=acn_el.text.strip() if acn_el else "",
+        address=addr_el.text.strip() if addr_el else "",
+    )
+
+
+def _parse_readings(soup: BeautifulSoup) -> list[MeterReading]:
+    """Extract meter readings from the history page."""
+    readings = []
+    rows = soup.select(".meter-reading-history-table-data-row.desktop-layout")
+    for row in rows:
+        date_el = row.select_one(".meter-reading-history-table-data-date-row-item")
+        amount_el = row.select_one(".meter-reading-history-table-data-amount-row-item")
+        type_el = row.select_one(".meter-reading-history-table-data-type-row-item")
+        if date_el and amount_el:
+            try:
+                date = _parse_date(date_el.text.strip())
+                # Parse amount and unit (e.g. "8551 kWh" -> 8551, "kWh")
+                amount_parts = amount_el.text.strip().split()
+                amount = float(amount_parts[0])
+                unit = amount_parts[1] if len(amount_parts) > 1 else ""
+                reading_type = type_el.text.strip() if type_el else ""
+                readings.append(
+                    MeterReading(
+                        date=date,
+                        amount=amount,
+                        unit=unit,
+                        reading_type=reading_type,
+                    )
+                )
+            except (ValueError, TypeError) as err:
+                _LOGGER.debug("Failed to parse meter reading row: %s", err)
+
+    return readings
+
+
+def _parse_bills(soup: BeautifulSoup) -> list[Bill]:
+    """Extract bills from the bill history page."""
+    bills = []
+    rows = soup.select(".bill-history-table-data-row")
+    for row in rows:
+        date_el = row.select_one(".bill-history-table-data-row-text-item")
+        amount_el = row.select_one(
+            ".bill-history-table-data-row-item-right"
+            ".bill-history-table-data-row-text-item"
+        )
+        link_el = row.select_one("a.bill-history-view-bill-button")
+        if date_el and amount_el:
+            try:
+                date = _parse_date(date_el.text.strip())
+                # Parse amount (e.g. "£172.26" -> 172.26)
+                amount_text = amount_el.text.strip().lstrip("£").replace(",", "")
+                amount = float(amount_text)
+                detail_url = ""
+                if link_el:
+                    href = _get_attr(link_el, "href")
+                    detail_url = f"{BASE_URL}{href}" if href else ""
+                bills.append(Bill(date=date, amount=amount, detail_url=detail_url))
+            except (ValueError, TypeError) as err:
+                _LOGGER.debug("Failed to parse bill row: %s", err)
+
+    return bills

switch2-0.1.0/switch2.egg-info/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: switch2
+Version: 0.1.0
+Summary: Async client library for the Switch2 energy portal
+Author-email: Jelmer Vernooij <jelmer@jelmer.uk>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/jelmer/python-switch2
+Project-URL: Repository, https://github.com/jelmer/python-switch2
+Project-URL: Issues, https://github.com/jelmer/python-switch2/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: aiohttp>=3.8
+Requires-Dist: beautifulsoup4>=4.12
+
+# python-switch2
+
+Async Python client library for the [Switch2](https://my.switch2.co.uk) energy portal.
+
+## Installation
+
+```sh
+pip install switch2
+```
+
+## Usage
+
+```python
+import asyncio
+from switch2 import Switch2ApiClient
+
+async def main():
+    client = Switch2ApiClient("you@example.com", "your-password")
+    try:
+        data = await client.fetch_data()
+        print(f"Customer: {data.customer.name}")
+        for reading in data.readings:
+            print(f"  {reading.date}: {reading.amount} {reading.unit}")
+        for bill in data.bills:
+            print(f"  {bill.date}: £{bill.amount}")
+    finally:
+        await client.close()
+
+asyncio.run(main())
+```
+
+## License
+
+Apache-2.0

switch2-0.1.0/switch2.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+switch2/__init__.py
+switch2/api.py
+switch2.egg-info/PKG-INFO
+switch2.egg-info/SOURCES.txt
+switch2.egg-info/dependency_links.txt
+switch2.egg-info/requires.txt
+switch2.egg-info/top_level.txt
+tests/test_api.py

switch2-0.1.0/switch2.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

switch2-0.1.0/switch2.egg-info/requires.txt

@@ -0,0 +1,2 @@
+aiohttp>=3.8
+beautifulsoup4>=4.12

switch2-0.1.0/switch2.egg-info/top_level.txt

@@ -0,0 +1 @@
+switch2

switch2-0.1.0/tests/test_api.py

@@ -0,0 +1,148 @@
+"""Tests for the Switch2 API client."""
+
+import unittest
+from datetime import datetime
+
+from bs4 import BeautifulSoup
+
+from switch2.api import (
+    _parse_bills,
+    _parse_customer_info,
+    _parse_date,
+    _parse_readings,
+)
+
+
+class ParseDateTests(unittest.TestCase):
+    def test_ordinal_th(self) -> None:
+        self.assertEqual(_parse_date("27th February 2026"), datetime(2026, 2, 27))
+
+    def test_ordinal_st(self) -> None:
+        self.assertEqual(_parse_date("1st January 2025"), datetime(2025, 1, 1))
+
+    def test_ordinal_nd(self) -> None:
+        self.assertEqual(_parse_date("2nd March 2025"), datetime(2025, 3, 2))
+
+    def test_ordinal_rd(self) -> None:
+        self.assertEqual(_parse_date("3rd April 2025"), datetime(2025, 4, 3))
+
+    def test_abbreviated_month(self) -> None:
+        self.assertEqual(_parse_date("15th Jan 2025"), datetime(2025, 1, 15))
+
+    def test_invalid_date(self) -> None:
+        with self.assertRaises(ValueError):
+            _parse_date("not a date")
+
+
+class ParseCustomerInfoTests(unittest.TestCase):
+    def test_full_info(self) -> None:
+        html = """
+        <div>
+            <span class="customer-info-name">John Doe</span>
+            <span class="customer-info-account-number">ACC-123</span>
+            <span class="customer-info-address">42 Test Lane</span>
+        </div>
+        """
+        soup = BeautifulSoup(html, "html.parser")
+        info = _parse_customer_info(soup)
+        self.assertEqual(info.name, "John Doe")
+        self.assertEqual(info.account_number, "ACC-123")
+        self.assertEqual(info.address, "42 Test Lane")
+
+    def test_missing_elements(self) -> None:
+        soup = BeautifulSoup("<div></div>", "html.parser")
+        info = _parse_customer_info(soup)
+        self.assertEqual(info.name, "")
+        self.assertEqual(info.account_number, "")
+        self.assertEqual(info.address, "")
+
+
+class ParseReadingsTests(unittest.TestCase):
+    def test_single_reading(self) -> None:
+        html = """
+        <div class="meter-reading-history-table-data-row desktop-layout">
+            <div class="meter-reading-history-table-data-date-row-item">
+                27th February 2026
+            </div>
+            <div class="meter-reading-history-table-data-amount-row-item">
+                8551 kWh
+            </div>
+            <div class="meter-reading-history-table-data-type-row-item">
+                Actual
+            </div>
+        </div>
+        """
+        soup = BeautifulSoup(html, "html.parser")
+        readings = _parse_readings(soup)
+        self.assertEqual(len(readings), 1)
+        self.assertEqual(readings[0].date, datetime(2026, 2, 27))
+        self.assertEqual(readings[0].amount, 8551.0)
+        self.assertEqual(readings[0].unit, "kWh")
+        self.assertEqual(readings[0].reading_type, "Actual")
+
+    def test_no_readings(self) -> None:
+        soup = BeautifulSoup("<div></div>", "html.parser")
+        self.assertEqual(_parse_readings(soup), [])
+
+    def test_amount_without_unit(self) -> None:
+        html = """
+        <div class="meter-reading-history-table-data-row desktop-layout">
+            <div class="meter-reading-history-table-data-date-row-item">
+                1st January 2025
+            </div>
+            <div class="meter-reading-history-table-data-amount-row-item">
+                1234
+            </div>
+        </div>
+        """
+        soup = BeautifulSoup(html, "html.parser")
+        readings = _parse_readings(soup)
+        self.assertEqual(len(readings), 1)
+        self.assertEqual(readings[0].unit, "")
+        self.assertEqual(readings[0].reading_type, "")
+
+
+class ParseBillsTests(unittest.TestCase):
+    def test_single_bill(self) -> None:
+        bill_amount_cls = (
+            "bill-history-table-data-row-item-right"
+            " bill-history-table-data-row-text-item"
+        )
+        html = f"""
+        <div class="bill-history-table-data-row">
+            <div class="bill-history-table-data-row-text-item">
+                15th March 2025
+            </div>
+            <div class="{bill_amount_cls}">£172.26</div>
+            <a class="bill-history-view-bill-button"
+               href="/Credit/Bill/42">View</a>
+        </div>
+        """
+        soup = BeautifulSoup(html, "html.parser")
+        bills = _parse_bills(soup)
+        self.assertEqual(len(bills), 1)
+        self.assertEqual(bills[0].date, datetime(2025, 3, 15))
+        self.assertEqual(bills[0].amount, 172.26)
+        self.assertEqual(bills[0].detail_url, "https://my.switch2.co.uk/Credit/Bill/42")
+
+    def test_no_bills(self) -> None:
+        soup = BeautifulSoup("<div></div>", "html.parser")
+        self.assertEqual(_parse_bills(soup), [])
+
+    def test_bill_without_link(self) -> None:
+        bill_amount_cls = (
+            "bill-history-table-data-row-item-right"
+            " bill-history-table-data-row-text-item"
+        )
+        html = f"""
+        <div class="bill-history-table-data-row">
+            <div class="bill-history-table-data-row-text-item">
+                1st January 2025
+            </div>
+            <div class="{bill_amount_cls}">£50.00</div>
+        </div>
+        """
+        soup = BeautifulSoup(html, "html.parser")
+        bills = _parse_bills(soup)
+        self.assertEqual(len(bills), 1)
+        self.assertEqual(bills[0].detail_url, "")