Skip to main content

Asynchronous Python client for Rako Controls Lighting

Project description

Python: Rako Controls API Client

GitHub Release Project Stage Project Maintenance License

Build Status Code Coverage Code Quality

Buy me a coffee

Asynchronous Python client for Rako Controls.

About

This package allows you to control and monitor Rako Controls devices programmatically. It is mainly created to allow third-party programs to automate their behavior.

Installation

pip install python-rako

Usage

import asyncio


async def main():
    # TODO
    pass


if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

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! :heart_eyes:

Setting up development environment

In case you'd like to contribute, a Makefile has been included to ensure a quick start.

make venv
source ./venv/bin/activate
make dev

Now you can start developing, run make without arguments to get an overview of all make goals that are available (including description):

$ make
Asynchronous Python client for Rako Controls Lighting.

Usage:
  make help                            Shows this message.
  make dev                             Set up a development environment.
  make lint                            Run all linters.
  make lint-black                      Run linting using black & blacken-docs.
  make lint-flake8                     Run linting using flake8 (pycodestyle/pydocstyle).
  make lint-pylint                     Run linting using PyLint.
  make lint-mypy                       Run linting using MyPy.
  make test                            Run tests quickly with the default Python.
  make coverage                        Check code coverage quickly with the default Python.
  make install                         Install the package to the active Python's site-packages.
  make clean                           Removes build, test, coverage and Python artifacts.
  make clean-all                       Removes all venv, build, test, coverage and Python artifacts.
  make clean-build                     Removes build artifacts.
  make clean-pyc                       Removes Python file artifacts.
  make clean-test                      Removes test and coverage artifacts.
  make clean-venv                      Removes Python virtual environment artifacts.
  make dist                            Builds source and wheel package.
  make release                         Release build on PyP
  make venv                            Create Python venv environment.

Authors & contributors

The original setup of this repository is by Ben Marengo.

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

License

License

Project details


Download files

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

Source Distribution

python_rako_2025-0.4.1.tar.gz (209.1 kB view details)

Uploaded Source

Built Distribution

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

python_rako_2025-0.4.1-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file python_rako_2025-0.4.1.tar.gz.

File metadata

  • Download URL: python_rako_2025-0.4.1.tar.gz
  • Upload date:
  • Size: 209.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for python_rako_2025-0.4.1.tar.gz
Algorithm Hash digest
SHA256 fe81396ea3e12080753e425cabee497266751db088bf77f2ce15e8c4bf614b22
MD5 e3cfbc0acc5dc1fd1f738dfdcae859db
BLAKE2b-256 13b99f03352c12a594f22ea3372e48f12bfc3d21a89412f148ab2fb6c484c85b

See more details on using hashes here.

File details

Details for the file python_rako_2025-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for python_rako_2025-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 57205d873dd7d344ebbe50a244982fc39f7b959282f4df7091dfe01089e7cd11
MD5 28178268f72a1f3abf49f92365d5afcf
BLAKE2b-256 84d0da96e7cb8f59dcf9fa42ec884964e35d23b45eb736d871df17d9c3336471

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