obi-energy-tracker 0.1.0__tar.gz

obi_energy_tracker-0.1.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

obi_energy_tracker-0.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @FabiNaryOBI @clemenslermen-obi

obi_energy_tracker-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,45 @@
+name: Bug report
+description: Something in the library does not behave as documented
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This is the API client. If the problem is with entities, the config flow or the
+        Energy dashboard, report it in the OBI ENERGY TRACKER Home Assistant integration
+        repository instead.
+  - type: input
+    id: version
+    attributes:
+      label: Library version
+      placeholder: 0.1.0
+    validations:
+      required: true
+  - type: input
+    id: python
+    attributes:
+      label: Python version
+      placeholder: "3.14.2"
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened
+      description: What did you expect, and what happened instead?
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: How to reproduce
+      description: The smallest snippet that shows the problem.
+      render: python
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Traceback or log output
+      description: Remove access tokens and personal data before pasting.
+      render: shell

obi_energy_tracker-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Security vulnerability
+    url: https://github.com/OBI-Smart-Technologies/energy-tracker-api-client-python/security/advisories/new
+    about: Report privately, never as a public issue

obi_energy_tracker-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,22 @@
+name: Feature request
+description: Ask for a new endpoint, model field or helper
+labels: [enhancement]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What are you trying to do?
+      description: The use case, not the implementation.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed API
+      description: How would you like to call it?
+      render: python
+  - type: textarea
+    id: context
+    attributes:
+      label: Anything else
+      description: Endpoint documentation, payload examples, related issues.

obi_energy_tracker-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+## What does this change?
+
+<!-- One or two sentences, and the issue it closes. -->
+
+## Type of change
+
+- [ ] Bug fix (no public API change)
+- [ ] New feature (new public name, backwards compatible)
+- [ ] Breaking change (public name removed, renamed or behaving differently)
+- [ ] Documentation or tooling only
+
+## Checklist
+
+- [ ] `pytest` passes
+- [ ] `ruff check src tests` and `ruff format --check src tests` pass
+- [ ] `mypy` passes
+- [ ] Tests cover the change
+- [ ] No `homeassistant` import was added
+- [ ] `CHANGELOG.md` has an entry under `## Unreleased`
+- [ ] The public surface in `__init__.py` (`__all__`) is up to date

obi_energy_tracker-0.1.0/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5
+    groups:
+      dev-dependencies:
+        patterns:
+          - "*"
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly

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

@@ -0,0 +1,65 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint and type check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.14"
+          cache: pip
+      - run: pip install -e ".[dev]"
+      - name: ruff check
+        run: ruff check src tests
+      - name: ruff format
+        run: ruff format --check src tests
+      - name: mypy
+        run: mypy
+
+  test:
+    name: Test on Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - run: pip install -e ".[dev]"
+      - run: pytest --cov --cov-report=term-missing
+
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.14"
+      - run: pip install build twine
+      - run: python -m build
+      - name: Check metadata
+        run: twine check --strict dist/*
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/

obi_energy_tracker-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,108 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      index:
+        description: Package index to publish to
+        type: choice
+        options:
+          - pypi
+          - testpypi
+        default: pypi
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - name: Refuse to release from anything but main
+        run: |
+          if [ "${{ github.ref }}" != "refs/heads/main" ]; then
+            echo "::error::Releases are cut from main only, not from ${{ github.ref }}."
+            exit 1
+          fi
+      - name: Refuse to release without a license
+        run: |
+          if [ ! -f LICENSE ]; then
+            echo "::error::No LICENSE file. An unlicensed package on PyPI may not legally be used by anyone — add the license before releasing."
+            exit 1
+          fi
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.14"
+      - name: Read version from pyproject.toml
+        id: version
+        run: |
+          version="$(python -c 'import pathlib, tomllib; print(tomllib.loads(pathlib.Path("pyproject.toml").read_text())["project"]["version"])')"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+          echo "Releasing version $version"
+      - name: Refuse to release an already tagged version
+        if: inputs.index == 'pypi'
+        run: |
+          if git rev-parse -q --verify "refs/tags/v${{ steps.version.outputs.version }}" >/dev/null; then
+            echo "::error::Tag v${{ steps.version.outputs.version }} already exists. Bump the version in pyproject.toml first."
+            exit 1
+          fi
+      - run: pip install build twine
+      - run: python -m build
+      - name: Check metadata
+        run: twine check --strict dist/*
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to ${{ inputs.index }}
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: ${{ inputs.index }}
+      url: ${{ inputs.index == 'pypi' && 'https://pypi.org/project/obi-energy-tracker/' || 'https://test.pypi.org/project/obi-energy-tracker/' }}${{ needs.build.outputs.version }}
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to TestPyPI
+        if: inputs.index == 'testpypi'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+      - name: Publish to PyPI
+        if: inputs.index == 'pypi'
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  tag:
+    name: Tag and create GitHub release
+    needs: [build, publish]
+    if: inputs.index == 'pypi'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - name: Create tag and release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          VERSION: ${{ needs.build.outputs.version }}
+        run: |
+          gh release create "v$VERSION" dist/* \
+            --title "v$VERSION" \
+            --generate-notes \
+            --target "$GITHUB_SHA"

obi_energy_tracker-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+.idea/
+*.iml
+.vscode/
+.DS_Store
+
+AGENTS.md
+CLAUDE.md

obi_energy_tracker-0.1.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this
+project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 0.1.0 - 2026-09-23
+
+First public release. Extracted from the OBI ENERGY TRACKER Home Assistant integration,
+where this code ran as an in-tree module.
+
+### Added
+
+- `ObiEnergyTrackerApi` — async REST client for the OBI ENERGY TRACKER cloud with one
+  method per endpoint: `async_get_bridges`, `async_get_bridge_measures`,
+  `async_get_meter_readings`, `async_set_outlet_state`,
+  `async_get_bridge_firmware_update`, `async_trigger_bridge_firmware_update`.
+  `async_get_bridge_measures` covers both windows: with a `duration` the recent values of
+  every device, without one their complete history in a single request.
+- `Bridge`, `Device`, `MeasureRecord` and `FirmwareUpdate` payload models, plus the
+  `DeviceKind`, `OutletState`, `Measure`, `OtaStatus` and `ConnectionStrength` enums.
+- `ObiEnergyTrackerError` with the `ObiEnergyTrackerAuthError` and
+  `ObiEnergyTrackerDeviceOfflineError` subclasses.
+- `TokenProvider` and `static_token_provider` — authentication is awaited before every
+  request, so the caller keeps ownership of the OAuth2 session.
+- `connection_strength_from_rssi` — the backend's own RSSI thresholds.
+- `hourly_buckets` and `cumulative` — hourly and cumulative consumption.

obi_energy_tracker-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement, listed in [CODEOWNERS](.github/CODEOWNERS). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

obi_energy_tracker-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing
+
+Thanks for taking the time to contribute. This library is the API layer of the
+[OBI ENERGY TRACKER Home Assistant integration](https://github.com/FabiNaryOBI/ha-obi-energy-tracker),
+so a change here can reach every Home Assistant user of the integration.
+
+By participating you agree to the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Development setup
+
+```bash
+python3.14 -m venv .venv
+.venv/bin/pip install -e ".[dev]"
+```
+
+## Checks
+
+All four have to pass before a pull request can be merged; CI runs exactly these:
+
+```bash
+.venv/bin/python -m pytest
+.venv/bin/ruff check src tests
+.venv/bin/ruff format --check src tests
+.venv/bin/mypy
+```
+
+Tests also run against the oldest supported Python (3.13) in CI.
+
+## Ground rules
+
+- **No Home Assistant imports.** The library must stay usable without Home Assistant.
+  Anything that needs `homeassistant` belongs in the integration repository.
+- **Async only.** No blocking I/O, no `requests`, no thread pools. The caller supplies the
+  `aiohttp.ClientSession`; the library never creates or closes one.
+- **Fully typed.** `mypy --strict` is clean and `py.typed` is shipped, so consumers get
+  the types. New public functions need annotations, not `Any`.
+- **Unknown values do not escape.** A `state`, `measure` or
+  `otaStatus` the library does not know parses to `None` or is dropped. Never pass a raw
+  backend string to the caller.
+- **Every request carries an explicit timeout.** A shared session's default is far too
+  coarse to rely on.
+- **Tests need no network.** `tests/conftest.py` starts a real local `aiohttp` server
+  (`FakeBackend`); queue responses with `backend.respond(...)` and assert on
+  `backend.requests`. Do not add an HTTP mocking dependency — `aioresponses` breaks
+  whenever `aiohttp` changes its internals.
+- **Keep the public surface small.** `__init__.py`'s `__all__` is the contract; everything
+  else is an implementation detail and may change in a patch release.
+
+## Pull requests
+
+1. Branch off `main` (`feat/…`, `fix/…`, `docs/…`).
+2. Keep the change focused, and add tests for it.
+3. Add an entry under `## Unreleased` in [CHANGELOG.md](CHANGELOG.md).
+4. Open the pull request and fill in the template.
+
+## Versioning
+
+[Semantic Versioning](https://semver.org/). The Home Assistant integration pins this
+package exactly (`obi-energy-tracker==X.Y.Z` in its `manifest.json`), so any change to the
+public surface has to be reflected in the version number:
+
+- **major** — a removed or renamed public name, a changed signature, changed parsing
+  semantics
+- **minor** — new endpoints, new public helpers, new model fields
+- **patch** — bug fixes and internals
+
+## Releasing
+
+Releases are cut manually by the repository owners; nothing is published on a push or a
+merge.
+
+The repository is licensed under the Apache License, Version 2.0; the copyright holder is
+OBI Smart Technologies GmbH. Contributions are accepted under the same license (see
+section 5 of the license). Do not remove `LICENSE` or `NOTICE` — the release workflow
+refuses to run without a `LICENSE` file, and both files are shipped in the distribution
+via `license-files` in `pyproject.toml`.
+
+1. Bump `version` in `pyproject.toml` and rename the `## Unreleased` heading in
+   `CHANGELOG.md` to `## X.Y.Z - YYYY-MM-DD`, leaving a fresh empty `## Unreleased` above
+   it.
+2. Merge that to `main`.
+3. Run the **Release** workflow (Actions → Release → *Run workflow*) with `index=testpypi`
+   first if the packaging changed, then with `index=pypi`. The workflow only runs on `main`.
+4. The workflow builds the distribution, refuses to continue if `vX.Y.Z` is already
+   tagged, waits for the `pypi` environment approval, publishes, and then creates the tag
+   and the GitHub release.