pyzonneplan 0.1.0__tar.gz

pyzonneplan-0.1.0/.gitignore

@@ -0,0 +1,222 @@
+# 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
+
+# Local dev copy of example.py containing real credentials, and its raw API dumps
+example_dev.py
+examples/.dumps/

pyzonneplan-0.1.0/LICENSE

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

pyzonneplan-0.1.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.5
+Name: pyzonneplan
+Version: 0.1.0
+Summary: Asynchronous Python client for the Zonneplan API
+Project-URL: Homepage, https://github.com/erwindouna/pyzonneplan
+Project-URL: Repository, https://github.com/erwindouna/pyzonneplan
+Project-URL: Documentation, https://erwindouna.github.io/pyzonneplan/
+Project-URL: Bug Tracker, https://github.com/erwindouna/pyzonneplan/issues
+Project-URL: Changelog, https://github.com/erwindouna/pyzonneplan/releases
+Author-email: Erwin Douna <e.douna@gmail.com>
+Maintainer-email: Erwin Douna <e.douna@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,async,battery,charge-point,client,pv,solar,zonneplan
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4,>=3.12
+Requires-Dist: aiohttp>=3.0.0
+Requires-Dist: mashumaro<4,>=3.17
+Requires-Dist: orjson<4,>=3.10.16
+Requires-Dist: tenacity>=9.0.0
+Requires-Dist: yarl>=1.6.0
+Description-Content-Type: text/markdown
+
+# pyzonneplan
+
+[![GitHub Release][releases-shield]][releases]
+[![Python Versions][python-versions-shield]][pypi]
+![Project Stage][project-stage-shield]
+![Project Maintenance][maintenance-shield]
+[![License][license-shield]](LICENSE)
+
+[![GitHub Activity][commits-shield]][commits-url]
+[![PyPI Downloads][downloads-shield]][downloads-url]
+[![GitHub Last Commit][last-commit-shield]][commits-url]
+[![Open in Dev Containers][devcontainer-shield]][devcontainer]
+
+[![Build Status][build-shield]][build-url]
+[![Typing Status][typing-shield]][typing-url]
+[![Code Coverage][codecov-shield]][codecov-url]
+
+Asynchronous Python client for the Zonneplan API.
+
+## About
+
+pyzonneplan is an async client for the [Zonneplan](https://www.zonneplan.nl/) API, focused on:
+
+- Solar (PV) installation data
+- Dynamic pricing and energy consumption data
+- Home battery monitoring and control modes
+- EV charge point sessions and schedules
+
+The library is under active development and endpoint coverage will keep expanding.
+
+## Installation
+
+```bash
+pip install pyzonneplan
+```
+
+## Usage
+
+Zonneplan authenticates with a one-time password mailed to the account address, rather than a plain username/password login:
+
+```python
+import asyncio
+
+from aiohttp import ClientSession
+from pyzonneplan import ZonneplanAuth
+
+
+async def main() -> None:
+    async with ClientSession() as session:
+        auth = ZonneplanAuth(session=session)
+        challenge = await auth.async_request_otp("you@example.com", source_name="pyzonneplan")
+
+        otp = input("Enter the one-time password mailed to you: ")
+        token = await auth.async_submit_otp(challenge, otp)
+
+        print("Access token:", token.access_token)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Store `token.as_dict()` and restore it later with `Token.from_dict(...)`; refresh it
+with `auth.async_refresh_token(token)` once it is close to `token.expires_at`.
+
+More examples can be found in the examples directory.
+
+## Documentation
+
+Project documentation and API reference: https://erwindouna.github.io/pyzonneplan/
+
+## Contributing
+
+Contributions are welcome. Please open an issue or pull request.
+
+For local development:
+
+```bash
+uv sync --all-groups && uv run pre-commit install
+```
+
+Run checks:
+
+```bash
+uv run pre-commit run --all-files
+```
+
+Run tests:
+
+```bash
+uv run pytest
+```
+
+## License
+
+MIT License
+
+Copyright (c) 2026 Erwin Douna
+
+<!-- MARKDOWN LINKS & IMAGES -->
+
+[build-shield]: https://github.com/erwindouna/pyzonneplan/actions/workflows/tests.yaml/badge.svg
+[build-url]: https://github.com/erwindouna/pyzonneplan/actions/workflows/tests.yaml
+[codecov-shield]: https://codecov.io/gh/erwindouna/pyzonneplan/branch/main/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/erwindouna/pyzonneplan
+[commits-shield]: https://img.shields.io/github/commit-activity/y/erwindouna/pyzonneplan.svg
+[commits-url]: https://github.com/erwindouna/pyzonneplan/commits/main
+[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
+[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/erwindouna/pyzonneplan
+[downloads-shield]: https://img.shields.io/pypi/dm/pyzonneplan
+[downloads-url]: https://pypistats.org/packages/pyzonneplan
+[last-commit-shield]: https://img.shields.io/github/last-commit/erwindouna/pyzonneplan.svg
+[license-shield]: https://img.shields.io/github/license/erwindouna/pyzonneplan.svg
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2026.svg
+[pypi]: https://pypi.org/project/pyzonneplan/
+[python-versions-shield]: https://img.shields.io/pypi/pyversions/pyzonneplan
+[releases-shield]: https://img.shields.io/github/release/erwindouna/pyzonneplan.svg
+[releases]: https://github.com/erwindouna/pyzonneplan/releases
+[typing-shield]: https://github.com/erwindouna/pyzonneplan/actions/workflows/typing.yaml/badge.svg
+[typing-url]: https://github.com/erwindouna/pyzonneplan/actions/workflows/typing.yaml

pyzonneplan-0.1.0/README.md

@@ -0,0 +1,121 @@
+# pyzonneplan
+
+[![GitHub Release][releases-shield]][releases]
+[![Python Versions][python-versions-shield]][pypi]
+![Project Stage][project-stage-shield]
+![Project Maintenance][maintenance-shield]
+[![License][license-shield]](LICENSE)
+
+[![GitHub Activity][commits-shield]][commits-url]
+[![PyPI Downloads][downloads-shield]][downloads-url]
+[![GitHub Last Commit][last-commit-shield]][commits-url]
+[![Open in Dev Containers][devcontainer-shield]][devcontainer]
+
+[![Build Status][build-shield]][build-url]
+[![Typing Status][typing-shield]][typing-url]
+[![Code Coverage][codecov-shield]][codecov-url]
+
+Asynchronous Python client for the Zonneplan API.
+
+## About
+
+pyzonneplan is an async client for the [Zonneplan](https://www.zonneplan.nl/) API, focused on:
+
+- Solar (PV) installation data
+- Dynamic pricing and energy consumption data
+- Home battery monitoring and control modes
+- EV charge point sessions and schedules
+
+The library is under active development and endpoint coverage will keep expanding.
+
+## Installation
+
+```bash
+pip install pyzonneplan
+```
+
+## Usage
+
+Zonneplan authenticates with a one-time password mailed to the account address, rather than a plain username/password login:
+
+```python
+import asyncio
+
+from aiohttp import ClientSession
+from pyzonneplan import ZonneplanAuth
+
+
+async def main() -> None:
+    async with ClientSession() as session:
+        auth = ZonneplanAuth(session=session)
+        challenge = await auth.async_request_otp("you@example.com", source_name="pyzonneplan")
+
+        otp = input("Enter the one-time password mailed to you: ")
+        token = await auth.async_submit_otp(challenge, otp)
+
+        print("Access token:", token.access_token)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Store `token.as_dict()` and restore it later with `Token.from_dict(...)`; refresh it
+with `auth.async_refresh_token(token)` once it is close to `token.expires_at`.
+
+More examples can be found in the examples directory.
+
+## Documentation
+
+Project documentation and API reference: https://erwindouna.github.io/pyzonneplan/
+
+## Contributing
+
+Contributions are welcome. Please open an issue or pull request.
+
+For local development:
+
+```bash
+uv sync --all-groups && uv run pre-commit install
+```
+
+Run checks:
+
+```bash
+uv run pre-commit run --all-files
+```
+
+Run tests:
+
+```bash
+uv run pytest
+```
+
+## License
+
+MIT License
+
+Copyright (c) 2026 Erwin Douna
+
+<!-- MARKDOWN LINKS & IMAGES -->
+
+[build-shield]: https://github.com/erwindouna/pyzonneplan/actions/workflows/tests.yaml/badge.svg
+[build-url]: https://github.com/erwindouna/pyzonneplan/actions/workflows/tests.yaml
+[codecov-shield]: https://codecov.io/gh/erwindouna/pyzonneplan/branch/main/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/erwindouna/pyzonneplan
+[commits-shield]: https://img.shields.io/github/commit-activity/y/erwindouna/pyzonneplan.svg
+[commits-url]: https://github.com/erwindouna/pyzonneplan/commits/main
+[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
+[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/erwindouna/pyzonneplan
+[downloads-shield]: https://img.shields.io/pypi/dm/pyzonneplan
+[downloads-url]: https://pypistats.org/packages/pyzonneplan
+[last-commit-shield]: https://img.shields.io/github/last-commit/erwindouna/pyzonneplan.svg
+[license-shield]: https://img.shields.io/github/license/erwindouna/pyzonneplan.svg
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2026.svg
+[pypi]: https://pypi.org/project/pyzonneplan/
+[python-versions-shield]: https://img.shields.io/pypi/pyversions/pyzonneplan
+[releases-shield]: https://img.shields.io/github/release/erwindouna/pyzonneplan.svg
+[releases]: https://github.com/erwindouna/pyzonneplan/releases
+[typing-shield]: https://github.com/erwindouna/pyzonneplan/actions/workflows/typing.yaml/badge.svg
+[typing-url]: https://github.com/erwindouna/pyzonneplan/actions/workflows/typing.yaml

pyzonneplan-0.1.0/pyproject.toml

@@ -0,0 +1,190 @@
+[project]
+name = "pyzonneplan"
+version = "0.1.0"
+description = "Asynchronous Python client for the Zonneplan API"
+authors = [{ name = "Erwin Douna", email = "e.douna@gmail.com" }]
+requires-python = ">=3.12,<4"
+readme = "README.md"
+license = "MIT"
+maintainers = [{ name = "Erwin Douna", email = "e.douna@gmail.com" }]
+keywords = [
+    "zonneplan",
+    "solar",
+    "pv",
+    "battery",
+    "charge-point",
+    "async",
+    "api",
+    "client",
+]
+classifiers = [
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "aiohttp>=3.0.0",
+    "yarl>=1.6.0",
+    "mashumaro>=3.17,<4",
+    "orjson>=3.10.16,<4",
+    "tenacity>=9.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/erwindouna/pyzonneplan"
+Repository = "https://github.com/erwindouna/pyzonneplan"
+Documentation = "https://erwindouna.github.io/pyzonneplan/"
+"Bug Tracker" = "https://github.com/erwindouna/pyzonneplan/issues"
+Changelog = "https://github.com/erwindouna/pyzonneplan/releases"
+
+[dependency-groups]
+dev = [
+    "aresponses==3.0.0",
+    "freezegun==1.5.5",
+    "codespell==2.4.3",
+    "covdefaults==2.3.0",
+    "coverage[toml]==7.15.4",
+    "mypy==2.3.1",
+    "pre-commit==4.6.2",
+    "pre-commit-hooks==6.0.0",
+    "pylint==4.0.7",
+    "pytest==9.1.1",
+    "pytest-asyncio==1.4.0",
+    "pytest-cov==7.1.0",
+    "ruff==0.16.4",
+    "syrupy==6.0.0",
+    "yamllint==1.38.0",
+]
+docs = [
+    "mkdocs>=1.6.1,<2",
+    "mkdocstrings[python]>=0.30.1,<1.1.0",
+    "mkdocs-material>=9.6.22,<10",
+]
+
+[tool.uv]
+default-groups = [
+    "dev",
+    "docs",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/pyzonneplan"]
+
+[tool.hatch.build.targets.wheel]
+include = ["src/pyzonneplan"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src/pyzonneplan" = "pyzonneplan"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.coverage.run]
+plugins = ["covdefaults"]
+source = ["pyzonneplan"]
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true
+
+[tool.mypy]
+platform = "linux"
+python_version = "3.12"
+show_column_numbers = true
+follow_imports = "normal"
+ignore_missing_imports = true
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+no_implicit_reexport = true
+strict_optional = true
+warn_incomplete_stub = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[tool.pylint.MASTER]
+ignore-paths = ["^tests/.*$"]
+extension-pkg-allow-list = ["orjson"]
+
+[tool.pylint.BASIC]
+good-names = ["_", "ex", "fp", "i", "id", "j", "k", "on", "Run", "T"]
+
+[tool.pylint."MESSAGES CONTROL"]
+disable = [
+    "duplicate-code",
+    "format",
+    "unsubscriptable-object",
+    "too-many-public-methods",
+    "too-few-public-methods",
+    "too-many-instance-attributes",
+    "too-many-arguments",
+]
+
+[tool.pylint.SIMILARITIES]
+ignore-imports = true
+
+[tool.pylint.FORMAT]
+max-line-length = 88
+
+[tool.pylint.DESIGN]
+max-attributes = 20
+
+[tool.pytest.ini_options]
+addopts = "--cov"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.ruff]
+lint.select = ["ALL"]
+lint.ignore = [
+    "ANN401",
+    "CPY001", # No copyright header convention in this project
+    "D203",
+    "D213",
+    "D417",
+    "PLR2004",
+    "SLOT000",
+    "PLR0913",
+    "PLR0912",
+    "COM812",
+    "ISC001",
+    "TRY003",
+    "TRY301",
+    "EM101",
+    "EM102",
+]
+line-length = 150
+
+[tool.ruff.lint.flake8-pytest-style]
+mark-parentheses = false
+fixture-parentheses = false
+
+[tool.ruff.lint.isort]
+known-first-party = ["pyzonneplan"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 25
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["S101", "S105", "S106", "S107", "S108", "DTZ001", "DTZ006", "PLC0415", "ARG001", "ARG002", "TC001", "TC002", "TC003", "SIM117", "SLF001"]
+"examples/**/*.py" = ["T201", "S106", "INP001", "ASYNC250"]
+# mashumaro's DataClassORJSONMixin resolves field annotations at runtime via
+# typing.get_type_hints(); moving these imports into `if TYPE_CHECKING:` blocks
+# (as TC001-TC003 suggest) raises mashumaro.exceptions.UnresolvedTypeReferenceError.
+"src/pyzonneplan/models/*.py" = ["TC001", "TC002", "TC003"]
+"src/pyzonneplan/pyzonneplan.py" = ["ASYNC109"]