Asynchronous Python client for the Frank Energie
Project description
python-frank-energie
Asyncio package to communicate with Frank Energie. This package is created to be used with https://github.com/bajansen/home-assistant-frank_energie.
Disclaimer
This package is not developed, nor supported by Frank Energie.
Installation
python3 -m pip install python-frank-energie
Contributing
This repo uses Python Poetry to easily run CI/CD scripts using a local environment. In combination with pre-commet you can make sure the PR passes the checks the first time.
- Clone and enter this repo
- Install poetry using
pip install poetry
- Install the environment using
poetry install
When making a commit, pre-commit runs to check, format and test the code. If everything passes you can push the changes via a Pull request. There GitHub Actions will check if you did everything right and it will notify me. Feel free to ask me to review your PR.
Some nice or useful commands:
poetry shell
-> Run commands likepytest test
with the correct environment, no need to prefix commands withpoetry run ...
(poetry run) pytest tests
-> Runs the unit tests(poetry run) pre-commit run --all-files
-> Run all pre-commit steps on all files.git commit -n ...
-> The-n
flag allows you to ignore the pre-commit result and make a commit, useful when you want to commit drafts. All commits form a PR will be squashed so you can do this any time.
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
Built Distribution
File details
Details for the file python_frank_energie-6.1.0.tar.gz
.
File metadata
- Download URL: python_frank_energie-6.1.0.tar.gz
- Upload date:
- Size: 13.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1021-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d272784cdff1ef240b9d7f85c5ca79a6211ac94b162f8c69b56ef8b456f39c59 |
|
MD5 | 03a649e1bd9f5e051ff82fe6707d37fc |
|
BLAKE2b-256 | 57391d230894b337df33e6ee42378d790316edc5ac7165c7d92a244d415829b4 |
File details
Details for the file python_frank_energie-6.1.0-py3-none-any.whl
.
File metadata
- Download URL: python_frank_energie-6.1.0-py3-none-any.whl
- Upload date:
- Size: 13.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1021-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06950ec790b4c978c169e36b39345dc730b9b5802153faa08fc8cb5eaca0e3e6 |
|
MD5 | 8b112f747aa86a981abf649a4356e410 |
|
BLAKE2b-256 | 795f3cb987ce1511ef6f72d14a64b36e3747143ce61d23c169849bc72c2b7282 |