Skip to content

halfguru/python-hilo

 
 

Repository files navigation

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 [email protected]

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 uses uv for dependency management and ruff for formatting and linting.

You need at least:

  • Python 3.11+
  • uv

To install all packages, including all development requirements:

uv sync

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:

uv run pre-commit run --all-files

To run just the Python tests:

uv 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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 100.0%