# Python: Rako Controls API Client
[![GitHub Release][releases-shield]][releases]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE)
[![Build Status][build-shield]][build]
[![Code Coverage][codecov-shield]][codecov]
[![Code Quality][code-quality-shield]][code-quality]
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
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
```bash
pip install python-rako
```
## Usage
```python
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][releases]
functionality. The format of the log is based on
[Keep a Changelog][keepchangelog].
Releases are based on [Semantic Versioning][semver], 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](CONTRIBUTING.md).
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.
```bash
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):
```bash
$ 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][marengaz].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
## License
[License](LICENSE)
[build-shield]: https://github.com/marengaz/python-rako/workflows/Continuous%20Integration/badge.svg
[build]: https://github.com/marengaz/python-rako/actions
[code-quality-shield]: https://img.shields.io/lgtm/grade/python/g/marengaz/python-rako.svg?logo=lgtm&logoWidth=18
[code-quality]: https://lgtm.com/projects/g/marengaz/python-rako/context:python
[codecov-shield]: https://codecov.io/gh/marengaz/python-rako/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/marengaz/python-rako
[contributors]: https://github.com/marengaz/python-rako/graphs/contributors
[marengaz]: https://github.com/marengaz
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
[license-shield]: https://img.shields.io/github/license/marengaz/python-rako.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[releases-shield]: https://img.shields.io/github/release/marengaz/python-rako.svg
[releases]: https://github.com/marengaz/python-rako/releases
[semver]: http://semver.org/spec/v2.0.0.html
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/marengaz
[github-actions-shield]: https://github.com/marengaz/rakomqtt/workflows/Test%20RakoMQTT/badge.svg?branch=master
[github-actions]: https://github.com/marengaz/rakomqtt/actions?query=workflow%3A%22Test+RakoMQTT%22+branch%3Amaster
Raw data
{
"_id": null,
"home_page": "https://github.com/simonleigh/python-rako",
"name": "python-rako-2025",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "rako, controls, api, async, client",
"author": "Simon Leigh",
"author_email": "Simon Leigh <simonleigh@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/43/13/e92d27a4770da689e47dab31cb24b01df3202a92f1a05b2a34e48fd4c263/python_rako_2025-0.0.1.tar.gz",
"platform": "any",
"description": "# Python: Rako Controls API Client\n\n[![GitHub Release][releases-shield]][releases]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE)\n\n[![Build Status][build-shield]][build]\n[![Code Coverage][codecov-shield]][codecov]\n[![Code Quality][code-quality-shield]][code-quality]\n\n[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]\n\nAsynchronous Python client for Rako Controls.\n\n## About\n\nThis package allows you to control and monitor Rako Controls devices\nprogrammatically. It is mainly created to allow third-party programs to automate\ntheir behavior.\n\n## Installation\n\n```bash\npip install python-rako\n```\n\n## Usage\n\n```python\nimport asyncio\n\n\nasync def main():\n # TODO\n pass\n\n\nif __name__ == \"__main__\":\n loop = asyncio.get_event_loop()\n loop.run_until_complete(main())\n```\n\n## Changelog & Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented\nbased on the following:\n\n- ``MAJOR``: Incompatible or major changes.\n- ``MINOR``: Backwards-compatible new features and enhancements.\n- ``PATCH``: Backwards-compatible bugfixes and package updates.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nIn case you'd like to contribute, a `Makefile` has been included to ensure a\nquick start.\n\n```bash\nmake venv\nsource ./venv/bin/activate\nmake dev\n```\n\nNow you can start developing, run `make` without arguments to get an overview\nof all make goals that are available (including description):\n\n```bash\n$ make\nAsynchronous Python client for Rako Controls Lighting.\n\nUsage:\n make help Shows this message.\n make dev Set up a development environment.\n make lint Run all linters.\n make lint-black Run linting using black & blacken-docs.\n make lint-flake8 Run linting using flake8 (pycodestyle/pydocstyle).\n make lint-pylint Run linting using PyLint.\n make lint-mypy Run linting using MyPy.\n make test Run tests quickly with the default Python.\n make coverage Check code coverage quickly with the default Python.\n make install Install the package to the active Python's site-packages.\n make clean Removes build, test, coverage and Python artifacts.\n make clean-all Removes all venv, build, test, coverage and Python artifacts.\n make clean-build Removes build artifacts.\n make clean-pyc Removes Python file artifacts.\n make clean-test Removes test and coverage artifacts.\n make clean-venv Removes Python virtual environment artifacts.\n make dist Builds source and wheel package.\n make release Release build on PyP\n make venv Create Python venv environment.\n```\n\n## Authors & contributors\n\nThe original setup of this repository is by [Ben Marengo][marengaz].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n## License\n\n[License](LICENSE)\n\n[build-shield]: https://github.com/marengaz/python-rako/workflows/Continuous%20Integration/badge.svg\n[build]: https://github.com/marengaz/python-rako/actions\n[code-quality-shield]: https://img.shields.io/lgtm/grade/python/g/marengaz/python-rako.svg?logo=lgtm&logoWidth=18\n[code-quality]: https://lgtm.com/projects/g/marengaz/python-rako/context:python\n[codecov-shield]: https://codecov.io/gh/marengaz/python-rako/branch/master/graph/badge.svg\n[codecov]: https://codecov.io/gh/marengaz/python-rako\n[contributors]: https://github.com/marengaz/python-rako/graphs/contributors\n[marengaz]: https://github.com/marengaz\n[keepchangelog]: http://keepachangelog.com/en/1.0.0/\n[license-shield]: https://img.shields.io/github/license/marengaz/python-rako.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg\n[releases-shield]: https://img.shields.io/github/release/marengaz/python-rako.svg\n[releases]: https://github.com/marengaz/python-rako/releases\n[semver]: http://semver.org/spec/v2.0.0.html\n\n[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg\n[buymeacoffee]: https://www.buymeacoffee.com/marengaz\n[github-actions-shield]: https://github.com/marengaz/rakomqtt/workflows/Test%20RakoMQTT/badge.svg?branch=master\n[github-actions]: https://github.com/marengaz/rakomqtt/actions?query=workflow%3A%22Test+RakoMQTT%22+branch%3Amaster\n",
"bugtrack_url": null,
"license": null,
"summary": "Asynchronous Python client for Rako Controls Lighting",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/simonleigh/python-rako",
"Issues": "https://github.com/simonleigh/python-rako/issues",
"Repository": "https://github.com/simonleigh/python-rako"
},
"split_keywords": [
"rako",
" controls",
" api",
" async",
" client"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6a7b3e074b012732b567be635720145c7e40f1d3363f7f54fd251c6a8d7fea4d",
"md5": "0020ff02e1f9653650cb114ad91d282c",
"sha256": "3b37c356176ea7e0a93f67b9ca5a0a1029c35d627070a4d80c4d72b4f5dd6283"
},
"downloads": -1,
"filename": "python_rako_2025-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0020ff02e1f9653650cb114ad91d282c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 11801,
"upload_time": "2025-07-08T21:50:17",
"upload_time_iso_8601": "2025-07-08T21:50:17.202684Z",
"url": "https://files.pythonhosted.org/packages/6a/7b/3e074b012732b567be635720145c7e40f1d3363f7f54fd251c6a8d7fea4d/python_rako_2025-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4313e92d27a4770da689e47dab31cb24b01df3202a92f1a05b2a34e48fd4c263",
"md5": "2b566f45760e3666e6b8bb7cd9293c31",
"sha256": "cb43450efe432ec0b9932bc144c9852f17b56193a7a813c040bd058b051a4a59"
},
"downloads": -1,
"filename": "python_rako_2025-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2b566f45760e3666e6b8bb7cd9293c31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15152,
"upload_time": "2025-07-08T21:50:18",
"upload_time_iso_8601": "2025-07-08T21:50:18.614468Z",
"url": "https://files.pythonhosted.org/packages/43/13/e92d27a4770da689e47dab31cb24b01df3202a92f1a05b2a34e48fd4c263/python_rako_2025-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 21:50:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "simonleigh",
"github_project": "python-rako",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": []
},
{
"name": "asyncio-dgram",
"specs": []
},
{
"name": "xmltodict",
"specs": []
}
],
"lcname": "python-rako-2025"
}
JSON
