python-mytnb 0.1.0__tar.gz

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

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev, main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --extra dev
+      - run: uv run pylint src/mytnb/ tests/
+      - run: uv run ruff check src/mytnb/ tests/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --extra dev
+      - run: uv run pytest tests/ -v

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

@@ -0,0 +1,23 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        with:
+          enable-cache: true
+      - name: Build package
+        run: uv build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0

python_mytnb-0.1.0/.gitignore

@@ -0,0 +1,27 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+*.whl
+.pytest_cache/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Reverse-engineering artifacts
+resources/
+
+# Config with credentials
+mytnb.json

python_mytnb-0.1.0/LICENSE

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

python_mytnb-0.1.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: python-mytnb
+Version: 0.1.0
+Summary: Python library to interface with the myTNB API (Tenaga Nasional Berhad)
+Project-URL: Repository, https://github.com/danieyal/python-mytnb
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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 :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: click>=8.3.3
+Requires-Dist: cryptography>=42.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.0
+Requires-Dist: rich>=15.0.0
+Requires-Dist: tls-client>=1.0
+Provides-Extra: dev
+Requires-Dist: pylint>=3.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# python-mytnb
+
+A Python library to interface with the myTNB (Tenaga Nasional Berhad) API for electricity account management and usage monitoring in Malaysia.
+
+## Installation
+
+```bash
+uv add python-mytnb
+```
+
+Or with pip:
+
+```bash
+pip install python-mytnb
+```
+
+## Quick Start
+
+```python
+import asyncio
+from mytnb import MyTNBClient
+
+async def main():
+    client = await MyTNBClient.login("user@example.com", "your-password")
+
+    async with client:
+        # Get smart meter usage & billing history
+        usage = await client.get_account_usage_smart("220123456789")
+
+        # Monthly billing breakdown
+        for month in usage.by_month.months:
+            print(f"{month.month} {month.year}: {month.usage_total} kWh — RM {month.amount_total}")
+
+        # Bill history & due amount
+        history = await client.get_bill_history("220123456789")
+        due = await client.get_account_due_amount("220123456789")
+
+asyncio.run(main())
+```
+
+## CLI
+
+Pass credentials directly:
+
+```bash
+mytnb --email user@example.com --password yourpass usage 220123456789
+```
+
+Or via environment variables:
+
+```bash
+export MYTNB_EMAIL=user@example.com
+export MYTNB_PASSWORD=yourpass
+mytnb usage 220123456789
+```
+
+All commands:
+
+```
+mytnb login                                  # Test login, show user info
+mytnb usage <account>                        # Monthly usage & billing summary
+mytnb usage --daily <account>                # Daily usage breakdown
+mytnb usage --json <account>                 # Full usage data as JSON
+mytnb current-usage <account>                # Simplified current usage summary
+mytnb due-amount <account>                   # Outstanding balance
+mytnb bill-history <account>                 # Payment history
+```
+
+Global options: `--debug` for full tracebacks, `--version`.
+
+Use a config file instead of flags (`--config <path>`, `mytnb.json`, or `~/.config/mytnb/config.json`):
+
+```bash
+mytnb init-config   # Generate a starter config file
+```
+
+## API Architecture
+
+myTNB uses two API backends, both handled transparently by this library:
+
+| Backend     | Domain                | Auth                                        | Used for                            |
+| ----------- | --------------------- | ------------------------------------------- | ----------------------------------- |
+| REST        | `api.mytnb.com.my`    | JWT + API key                               | Account listing, eligibility checks |
+| Legacy ASMX | `mytnbapp.tnb.com.my` | Encrypted payloads (AES-256-CBC + RSA-OAEP) | Usage data, billing, services       |
+
+Request encryption for the ASMX API is automatic — just pass plaintext parameters.
+
+## Data Models
+
+| Model           | Description                                          |
+| --------------- | ---------------------------------------------------- |
+| `AccountUsage`  | Full usage response: metrics, monthly and daily data |
+| `UsageMetric`   | Current/average usage (kWh)                          |
+| `CostMetric`    | Current/projected cost (RM)                          |
+| `BillingMonth`  | Monthly billing record with tariff blocks            |
+| `DailyUsage`    | Daily consumption and cost                           |
+| `TariffBlock`   | Tariff pricing block details                         |
+| `SMRAccount`    | Smart Meter Reading eligibility status               |
+| `BREligibility` | Bill rendering opt-in status                         |
+
+## Geographic Restrictions
+
+The myTNB API only accepts connections from **Malaysian IP addresses** and blocks most VPN services. If you get a `GeoBlockedError` (HTTP 403), make sure you are connecting from a Malaysian network without a VPN.
+
+## Error Handling
+
+```python
+from mytnb.exceptions import MyTNBError, APIError, AuthenticationError, GeoBlockedError
+
+try:
+    client = await MyTNBClient.login("user@example.com", "password")
+    async with client:
+        usage = await client.get_account_usage_smart("220123456789")
+except GeoBlockedError:
+    print("Blocked — connect from a Malaysian IP without VPN")
+except AuthenticationError:
+    print("Invalid email or password")
+except APIError as e:
+    print(f"API error {e.error_code}: {e.display_message}")
+except MyTNBError as e:
+    print(f"Error: {e}")
+```
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest
+uv run pylint src/mytnb/
+```
+
+## License
+
+MIT

python_mytnb-0.1.0/README.md

@@ -0,0 +1,134 @@
+# python-mytnb
+
+A Python library to interface with the myTNB (Tenaga Nasional Berhad) API for electricity account management and usage monitoring in Malaysia.
+
+## Installation
+
+```bash
+uv add python-mytnb
+```
+
+Or with pip:
+
+```bash
+pip install python-mytnb
+```
+
+## Quick Start
+
+```python
+import asyncio
+from mytnb import MyTNBClient
+
+async def main():
+    client = await MyTNBClient.login("user@example.com", "your-password")
+
+    async with client:
+        # Get smart meter usage & billing history
+        usage = await client.get_account_usage_smart("220123456789")
+
+        # Monthly billing breakdown
+        for month in usage.by_month.months:
+            print(f"{month.month} {month.year}: {month.usage_total} kWh — RM {month.amount_total}")
+
+        # Bill history & due amount
+        history = await client.get_bill_history("220123456789")
+        due = await client.get_account_due_amount("220123456789")
+
+asyncio.run(main())
+```
+
+## CLI
+
+Pass credentials directly:
+
+```bash
+mytnb --email user@example.com --password yourpass usage 220123456789
+```
+
+Or via environment variables:
+
+```bash
+export MYTNB_EMAIL=user@example.com
+export MYTNB_PASSWORD=yourpass
+mytnb usage 220123456789
+```
+
+All commands:
+
+```
+mytnb login                                  # Test login, show user info
+mytnb usage <account>                        # Monthly usage & billing summary
+mytnb usage --daily <account>                # Daily usage breakdown
+mytnb usage --json <account>                 # Full usage data as JSON
+mytnb current-usage <account>                # Simplified current usage summary
+mytnb due-amount <account>                   # Outstanding balance
+mytnb bill-history <account>                 # Payment history
+```
+
+Global options: `--debug` for full tracebacks, `--version`.
+
+Use a config file instead of flags (`--config <path>`, `mytnb.json`, or `~/.config/mytnb/config.json`):
+
+```bash
+mytnb init-config   # Generate a starter config file
+```
+
+## API Architecture
+
+myTNB uses two API backends, both handled transparently by this library:
+
+| Backend     | Domain                | Auth                                        | Used for                            |
+| ----------- | --------------------- | ------------------------------------------- | ----------------------------------- |
+| REST        | `api.mytnb.com.my`    | JWT + API key                               | Account listing, eligibility checks |
+| Legacy ASMX | `mytnbapp.tnb.com.my` | Encrypted payloads (AES-256-CBC + RSA-OAEP) | Usage data, billing, services       |
+
+Request encryption for the ASMX API is automatic — just pass plaintext parameters.
+
+## Data Models
+
+| Model           | Description                                          |
+| --------------- | ---------------------------------------------------- |
+| `AccountUsage`  | Full usage response: metrics, monthly and daily data |
+| `UsageMetric`   | Current/average usage (kWh)                          |
+| `CostMetric`    | Current/projected cost (RM)                          |
+| `BillingMonth`  | Monthly billing record with tariff blocks            |
+| `DailyUsage`    | Daily consumption and cost                           |
+| `TariffBlock`   | Tariff pricing block details                         |
+| `SMRAccount`    | Smart Meter Reading eligibility status               |
+| `BREligibility` | Bill rendering opt-in status                         |
+
+## Geographic Restrictions
+
+The myTNB API only accepts connections from **Malaysian IP addresses** and blocks most VPN services. If you get a `GeoBlockedError` (HTTP 403), make sure you are connecting from a Malaysian network without a VPN.
+
+## Error Handling
+
+```python
+from mytnb.exceptions import MyTNBError, APIError, AuthenticationError, GeoBlockedError
+
+try:
+    client = await MyTNBClient.login("user@example.com", "password")
+    async with client:
+        usage = await client.get_account_usage_smart("220123456789")
+except GeoBlockedError:
+    print("Blocked — connect from a Malaysian IP without VPN")
+except AuthenticationError:
+    print("Invalid email or password")
+except APIError as e:
+    print(f"API error {e.error_code}: {e.display_message}")
+except MyTNBError as e:
+    print(f"Error: {e}")
+```
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest
+uv run pylint src/mytnb/
+```
+
+## License
+
+MIT

python_mytnb-0.1.0/pyproject.toml

@@ -0,0 +1,84 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "python-mytnb"
+version = "0.1.0"
+description = "Python library to interface with the myTNB API (Tenaga Nasional Berhad)"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "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 :: Software Development :: Libraries",
+]
+dependencies = [
+    "httpx>=0.27",
+    "pydantic>=2.0",
+    "cryptography>=42.0",
+    "tls_client>=1.0",
+    "click>=8.3.3",
+    "rich>=15.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "pylint>=3.0",
+    "ruff>=0.6",
+]
+
+[project.scripts]
+mytnb = "mytnb.cli:main"
+
+[project.urls]
+Repository = "https://github.com/danieyal/python-mytnb"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/mytnb"]
+
+[tool.pylint.main]
+load-plugins = []
+jobs = 0
+
+[tool.pylint.messages_control]
+disable = [
+    "missing-module-docstring",
+    "missing-class-docstring",
+    "missing-function-docstring",
+    "too-few-public-methods",
+    "too-many-arguments",
+    "too-many-instance-attributes",
+    "too-many-return-statements",
+    "too-many-branches",
+    "too-many-locals",
+    "line-too-long",
+    "fixme",
+    "broad-exception-caught",
+    "import-error",
+]
+
+[tool.pylint.format]
+max-line-length = 120
+
+[tool.pylint.basic]
+good-names = ["i", "j", "k", "v", "e", "f", "d", "ui", "di"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["mytnb"]

python_mytnb-0.1.0/src/mytnb/__init__.py

@@ -0,0 +1,26 @@
+"""Python library for the myTNB API."""
+
+from mytnb.client import MyTNBClient
+from mytnb.crypto import EncryptedPayload, encrypt_request
+from mytnb.models import (
+    AccountUsage,
+    BillingMonth,
+    CostMetric,
+    DailyUsage,
+    Metric,
+    TariffBlock,
+    UsageMetric,
+)
+
+__all__ = [
+    "MyTNBClient",
+    "EncryptedPayload",
+    "encrypt_request",
+    "AccountUsage",
+    "BillingMonth",
+    "CostMetric",
+    "DailyUsage",
+    "Metric",
+    "TariffBlock",
+    "UsageMetric",
+]

python_mytnb-0.1.0/src/mytnb/__main__.py

@@ -0,0 +1,5 @@
+"""Allow running as `python -m mytnb`."""
+
+from mytnb.cli import main
+
+main()

python_mytnb-0.1.0/src/mytnb/auth.py

@@ -0,0 +1,67 @@
+"""Authentication handling for myTNB API."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class DeviceInfo:
+    """Device information sent with API requests."""
+
+    device_id: str
+    app_version: str = "4.0.2"
+    os_type: str = "2"  # 1=Android, 2=iOS
+    os_version: str = "18.0"
+    device_desc: str = "EN"
+    version_code: str = "1425"
+
+    def to_dict(self) -> dict:
+        return {
+            "deviceId": self.device_id,
+            "appVersion": self.app_version,
+            "osType": self.os_type,
+            "osVersion": self.os_version,
+            "deviceDesc": self.device_desc,
+            "versionCode": self.version_code,
+        }
+
+
+@dataclass
+class UserInfo:
+    """User information for authenticated requests."""
+
+    user_name: str
+    user_id: str
+    display_name: str = ""
+    role_id: str = "16"
+    language: str = "EN"
+
+    def to_dict(self) -> dict:
+        return {
+            "RoleId": self.role_id,
+            "UserId": self.user_id,
+            "UserName": self.user_name,
+            "Lang": self.language,
+        }
+
+
+@dataclass
+class Credentials:
+    """API credentials for myTNB."""
+
+    # REST API (api.mytnb.com.my)
+    api_key: str
+    authorization_token: str
+    # Optional bearer token for some endpoints
+    bearer_token: Optional[str] = None
+    # Channel API key (static JWT)
+    channel_api_key: Optional[str] = None
+
+    # Legacy API (mytnbapp.tnb.com.my)
+    secure_key: Optional[str] = None
+
+    # User context
+    user_info: Optional[UserInfo] = None
+    device_info: Optional[DeviceInfo] = None