Skip to main content

A Python3, async interface to the Hilo API

Project description

python-hilo

GitHub Release License

Build Status Open in Dev Containers

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 me@dvd.dev

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.

Open in Dev Containers

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_hilo-2026.1.1.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_hilo-2026.1.1-py3-none-any.whl (39.1 kB view details)

Uploaded Python 3

File details

Details for the file python_hilo-2026.1.1.tar.gz.

File metadata

  • Download URL: python_hilo-2026.1.1.tar.gz
  • Upload date:
  • Size: 34.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for python_hilo-2026.1.1.tar.gz
Algorithm Hash digest
SHA256 b5db87f2869a61c860125879e7c852a106ff45eff441cec71d863ca49daed85a
MD5 b345d7ef37a6a9eb8a131ac9244e4776
BLAKE2b-256 3a6aeffe9375df09642380eef813e771b9f0e8265c96e0c002029e7dbbd6e61e

See more details on using hashes here.

File details

Details for the file python_hilo-2026.1.1-py3-none-any.whl.

File metadata

  • Download URL: python_hilo-2026.1.1-py3-none-any.whl
  • Upload date:
  • Size: 39.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for python_hilo-2026.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e679b9418095f7de816da615dfe862ae8cbf59b8e89e7b6f6d8642bc086a17db
MD5 8ed644072812863bdad32fd171929548
BLAKE2b-256 fed788264fb06e22dfe849f4cdcb8858204dfbff0e6128c7fd1b50ec34f6bc4b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page