python-hilo 2025.4.2

A Python3, async interface to the Hilo API

python-hilo

python-hilo (aka pyhilo) is a Python 3.11, asyncio-driven interface to the unofficial Hilo API from Hydro Quebec. This is meant to be integrated into Home Assistant but can also be used as a standalone library.

Home assistant integration is available here

TODO

• Type everything: almost done, got a few "type: ignore" to fix

Later?

• Full docstrings and doc generation
• Unit testing
• Functional testing

If anyone wants to contribute, feel free to submit a PR. If you'd like to sync up first, you can fire me an email [e-mail]

Setting up development environment

The easiest way to start, is by opening a CodeSpace here on GitHub, or by using the Dev Container feature of Visual Studio Code.

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

• Python 3.11+
• Poetry
• NodeJS 20+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The original setup of this repository is by David Vallée Delisle.

Credits to @frenck for the base container configuration. The license of python-wled can be found in third_party/python-wled/LICENSE.

For a full list of all authors and contributors, check the contributor's page.