python-rako-2025 0.0.1__tar.gz

python_rako_2025-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Ben Marengo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_rako_2025-0.0.1/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: python-rako-2025
+Version: 0.0.1
+Summary: Asynchronous Python client for Rako Controls Lighting
+Home-page: https://github.com/simonleigh/python-rako
+Author: Simon Leigh
+Author-email: Simon Leigh <simonleigh@users.noreply.github.com>
+Project-URL: Homepage, https://github.com/simonleigh/python-rako
+Project-URL: Repository, https://github.com/simonleigh/python-rako
+Project-URL: Issues, https://github.com/simonleigh/python-rako/issues
+Keywords: rako,controls,api,async,client
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.10.0
+Requires-Dist: asyncio-dgram>=2.2.0
+Requires-Dist: xmltodict>=0.13.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: platform
+Dynamic: requires-python
+
+# 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

python_rako_2025-0.0.1/README.md

@@ -0,0 +1,138 @@
+# 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

python_rako_2025-0.0.1/pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "python-rako-2025"
+version = "0.0.1"
+description = "Asynchronous Python client for Rako Controls Lighting"
+readme = "README.md"
+keywords = ["rako", "controls", "api", "async", "client"]
+authors = [
+    {name = "Simon Leigh", email = "simonleigh@users.noreply.github.com"},
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "aiohttp>=3.10.0",
+    "asyncio-dgram>=2.2.0",
+    "xmltodict>=0.13.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/simonleigh/python-rako"
+Repository = "https://github.com/simonleigh/python-rako"
+Issues = "https://github.com/simonleigh/python-rako/issues"
+
+
+[tool.setuptools.packages.find]
+include = ["python_rako*"]
+
+[tool.setuptools.package-data]
+python_rako = ["py.typed"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+    "PL", # pylint
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "B008",  # do not perform function calls in argument defaults
+    "C901",  # too complex
+    "PLR0913", # too many arguments
+    "PLR0912", # too many branches
+    "PLR0915", # too many statements
+]
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["PLR2004"]
+
+[tool.mypy]
+python_version = "3.10"
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+warn_unreachable = true
+strict_equality = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

python_rako_2025-0.0.1/python_rako/__init__.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+import asyncio
+import logging
+import socket
+from asyncio.trsock import TransportSocket  # noqa
+from typing import TypedDict
+
+import asyncio_dgram
+
+from python_rako.bridge import Bridge, BridgeCommanderHTTP, BridgeCommanderUDP  # noqa
+from python_rako.const import RAKO_BRIDGE_DEFAULT_PORT, MessageType, RequestType  # noqa
+from python_rako.exceptions import RakoBridgeError  # noqa
+from python_rako.model import (  # noqa
+    BridgeInfo,
+    ChannelLight,
+    ChannelStatusMessage,
+    LevelCache,
+    LevelCacheItem,
+    Light,
+    RoomChannel,
+    RoomLight,
+    SceneCache,
+    SceneStatusMessage,
+    UnsupportedMessage,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class BridgeDescription(TypedDict, total=False):
+    host: str
+    port: int
+    name: str
+    mac: str
+
+
+async def discover_bridge() -> BridgeDescription:
+    sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
+    server = await asyncio_dgram.from_socket(sock)
+    await server.send(b"D", ("255.255.255.255", RAKO_BRIDGE_DEFAULT_PORT))
+    msg, (host, port) = await server.recv()
+    bridge_description: BridgeDescription = {"host": host, "port": port}
+    try:
+        name, mac = msg.decode("utf8").split()
+        bridge_description["name"] = name
+        bridge_description["mac"] = mac
+    except ValueError:
+        raise ValueError(f"Couldn't interpret discovery response message: {msg}")
+    return bridge_description
+
+
+def main() -> None:
+    bridge_desc: BridgeDescription = asyncio.run(discover_bridge())
+    print(bridge_desc)
+
+
+if __name__ == "__main__":
+    main()

python_rako_2025-0.0.1/python_rako/__version__.py

@@ -0,0 +1,2 @@
+"""AUTOGENERATED ON RELEASE."""
+__version__ = "0.0.1"