Python: Asynchronous Python client for the Openmotics API

![GitHub Release][releases-shield] ![Python Versions][python-versions-shield]

Asynchronous Python client for the OpenMotics API.

About

An asynchronous python client for the OpenMotics API to control the outputs and other modules.

This library is created to support the integration in Home Assistant.

Installation

cd pyhaopenmotics
pip install .

Usage

See examples folder.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

• MAJOR: Incompatible or major changes.
• MINOR: Backwards-compatible new features and enhancements.
• PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! 😍

Setting up development environment

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.9+
• Poetry
• NodeJS 12+ (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 Wouter Coppens.

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

License

This project is licensed under the AGPLv3 License - see the LICENSE.md file for details