Metadata-Version: 2.4
Name: pyfinwhale
Version: 0.1.0
Summary: Async Python client for SunnyWhale FinWhale pool monitoring devices
Author: Brent Dukes
License-Expression: MIT
Project-URL: Homepage, https://github.com/TheDukeZip/pyfinwhale
Project-URL: Repository, https://github.com/TheDukeZip/pyfinwhale
Project-URL: Issues, https://github.com/TheDukeZip/pyfinwhale/issues
Project-URL: Changelog, https://github.com/TheDukeZip/pyfinwhale/blob/main/CHANGELOG.md
Keywords: finwhale,sunnywhale,pool,pool-monitoring,home-assistant,rainmaker
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp<4,>=3.9
Requires-Dist: platformdirs>=4.0.0
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: mypy>=1.10; extra == "dev"
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
Requires-Dist: pytest-cov>=5.0; extra == "dev"
Requires-Dist: ruff>=0.6; extra == "dev"
Requires-Dist: twine>=5.0; extra == "dev"
Dynamic: license-file

# pyfinwhale

An asynchronous Python client for SunnyWhale FinWhale pool monitoring devices.

> [!WARNING]
> This project is unofficial and is not affiliated with SunnyWhale,
> FinWhale, Espressif, or ESP RainMaker.

## Status

Early development. The API may change without notice before version 1.0. Minimally supports FinWhale version 1.6.7.

## Planned functionality

- Authenticate with the SunnyWhale cloud service
- Refresh expired access tokens
- Discover FinWhale devices
- Retrieve current pool telemetry
- Provide a command-line test client
- Support a future Home Assistant integration

- Does NOT currently support any other API calls, such as history, OTA firmware updates, manual control, device sharing, etc.

## Development setup

```bash
python -m venv .venv
