{"id":15420028,"url":"https://github.com/imicknl/python-overkiz-api","last_synced_at":"2026-06-07T14:01:12.972Z","repository":{"id":36960028,"uuid":"276867765","full_name":"iMicknl/python-overkiz-api","owner":"iMicknl","description":"Async Python wrapper to interact with internal Somfy TaHoma API, or other OverKiz API's.","archived":false,"fork":false,"pushed_at":"2025-05-15T09:07:39.000Z","size":3224,"stargazers_count":51,"open_issues_count":15,"forks_count":31,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-15T10:05:46.728Z","etag":null,"topics":["cozy-touch","hacktoberfest","hi-kumo","overkiz","pyhoma","python","rexel","somfy","tahoma","tahoma-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iMicknl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-03T10:00:46.000Z","updated_at":"2025-05-15T09:07:41.000Z","dependencies_parsed_at":"2023-07-15T06:07:57.099Z","dependency_job_id":"e128b1cc-6597-49d2-8149-c4b2646696f0","html_url":"https://github.com/iMicknl/python-overkiz-api","commit_stats":{"total_commits":1022,"total_committers":22,"mean_commits":46.45454545454545,"dds":"0.32681017612524466","last_synced_commit":"9b73bab7725393b9506a5277cb877988f57c2168"},"previous_names":["imicknl/python-tahoma-api"],"tags_count":128,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iMicknl%2Fpython-overkiz-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iMicknl%2Fpython-overkiz-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iMicknl%2Fpython-overkiz-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iMicknl%2Fpython-overkiz-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iMicknl","download_url":"https://codeload.github.com/iMicknl/python-overkiz-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254319720,"owners_count":22051073,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cozy-touch","hacktoberfest","hi-kumo","overkiz","pyhoma","python","rexel","somfy","tahoma","tahoma-api"],"created_at":"2024-10-01T17:27:56.108Z","updated_at":"2026-06-07T14:01:12.963Z","avatar_url":"https://github.com/iMicknl.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python client for OverKiz API\n\nA fully asynchronous and user-friendly API client for the OverKiz platform. This client enables interaction with smart devices connected to OverKiz, supporting multiple vendors such as Somfy TaHoma and Atlantic Cozytouch.\n\nThis package is primarily used by Home Assistant Core to provide the Overkiz integration. If you wish to use this package in your own project, refer to the [full documentation](https://imicknl.github.io/python-overkiz-api/), the [example below](#getting-started), or explore the [Home Assistant source code](https://github.com/home-assistant/core/tree/dev/homeassistant/components/overkiz) for additional usage examples.\n\n## Documentation\n\nFull documentation is available at **[imicknl.github.io/python-overkiz-api](https://imicknl.github.io/python-overkiz-api/)**:\n\n- [Getting started](https://imicknl.github.io/python-overkiz-api/getting-started/) — cloud and local API setup\n- [Core concepts](https://imicknl.github.io/python-overkiz-api/core-concepts/) — clients, servers, credentials, and models\n- [Device control](https://imicknl.github.io/python-overkiz-api/device-control/) and [event handling](https://imicknl.github.io/python-overkiz-api/event-handling/)\n- [Migrating from v1](https://imicknl.github.io/python-overkiz-api/migration-v2/)\n- [SDK reference](https://imicknl.github.io/python-overkiz-api/sdk-reference/)\n\n## Supported hubs\n\n- Atlantic Cozytouch\n- Bouygues Flexom\n- Brandt Smart Control †\n- Hitachi Hi Kumo\n- Nexity Eugénie\n- Rexel Energeasy Connect ‡\n- Sauter Cozytouch\n- Simu (LiveIn2)\n- Somfy Connexoon IO\n- Somfy Connexoon RTS\n- Somfy TaHoma\n- Somfy TaHoma Switch\n- Thermor Cozytouch\n\n† _This server's authentication method isn't supported yet. To use it, obtain an access token (by sniffing the original app) and create a local user on the Overkiz API platform._\n\n‡ _Requires OAuth credentials provided by Rexel._\n\n## Installation\n\n```bash\npip install pyoverkiz\n```\n\n## Getting started\n\nConnect to the cloud API, authenticate, and list your devices:\n\n```python\nimport asyncio\n\nfrom pyoverkiz.auth.credentials import UsernamePasswordCredentials\nfrom pyoverkiz.client import OverkizClient\nfrom pyoverkiz.enums import Server\n\n\nasync def main() -\u003e None:\n    async with OverkizClient(\n        server=Server.SOMFY_EUROPE,\n        credentials=UsernamePasswordCredentials(\"username\", \"password\"),\n    ) as client:\n        await client.login()\n\n        devices = await client.get_devices()\n        for device in devices:\n            print(f\"{device.label} ({device.device_url}) - {device.controllable_name}\")\n\n\nasyncio.run(main())\n```\n\nFor executing commands, listening to events, and connecting to the **local API**, see the [Getting started guide](https://imicknl.github.io/python-overkiz-api/getting-started/) in the documentation.\n\n## Projects using pyOverkiz\n\nThis package powers the Overkiz integration in [Home Assistant Core](https://www.home-assistant.io/integrations/overkiz/). Other open-source projects and custom automations also leverage pyOverkiz to interact with Overkiz-compatible hubs and devices, including:\n\n- [overkiz2mqtt](https://github.com/RichieB2B/overkiz2mqtt): Bridges Overkiz devices to MQTT for integration with various platforms.\n- [mcp-overkiz](https://github.com/phimage/mcp-overkiz): Implements an MCP server to enable communication between Overkiz devices and language models.\n- [tahoma](https://github.com/pzim-devdata/tahoma): Command Line Interface (CLI) to control Overkiz devices.\n\n\n## Contribute\n\nWe welcome contributions! To get started with setting up this project for development, follow the steps below.\n\n\n### Project setup\n#### Dev Container (recommended)\n\nIf you use Visual Studio Code with Docker or GitHub Codespaces, you can take advantage of the included [Dev Container](https://code.visualstudio.com/docs/devcontainers/containers). This environment comes pre-configured with all necessary dependencies and tools, including the correct Python version, making setup simple and straightforward.\n\n#### Manual setup\n\n- Install [uv](https://docs.astral.sh/uv/getting-started/installation).\n- Clone this repository and navigate to it: `cd python-overkiz-api`\n- Initialize the project with `uv sync`, then run `uv run prek install`\n\n#### Tests\n\n```bash\nuv run pytest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimicknl%2Fpython-overkiz-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimicknl%2Fpython-overkiz-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimicknl%2Fpython-overkiz-api/lists"}