{"id":19713753,"url":"https://github.com/hyperb1iss/signalrgb-python","last_synced_at":"2026-04-05T10:04:58.150Z","repository":{"id":249453906,"uuid":"831346637","full_name":"hyperb1iss/signalrgb-python","owner":"hyperb1iss","description":"Python library for SignalRGB","archived":false,"fork":false,"pushed_at":"2026-04-05T08:04:24.000Z","size":1299,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-05T08:23:29.670Z","etag":null,"topics":["client","library","python","signalrgb"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperb1iss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"hyperb1iss","ko_fi":"hyperb1iss"}},"created_at":"2024-07-20T09:35:10.000Z","updated_at":"2026-04-05T08:04:27.000Z","dependencies_parsed_at":"2024-09-14T17:06:07.654Z","dependency_job_id":null,"html_url":"https://github.com/hyperb1iss/signalrgb-python","commit_stats":null,"previous_names":["hyperb1iss/signalrgb-python"],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/hyperb1iss/signalrgb-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fsignalrgb-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fsignalrgb-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fsignalrgb-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fsignalrgb-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperb1iss","download_url":"https://codeload.github.com/hyperb1iss/signalrgb-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fsignalrgb-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31431459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T08:13:15.228Z","status":"ssl_error","status_checked_at":"2026-04-05T08:13:11.839Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["client","library","python","signalrgb"],"created_at":"2024-11-11T22:24:44.720Z","updated_at":"2026-04-05T10:04:58.140Z","avatar_url":"https://github.com/hyperb1iss.png","language":"Python","funding_links":["https://github.com/sponsors/hyperb1iss","https://ko-fi.com/hyperb1iss"],"categories":[],"sub_categories":[],"readme":"# 🌈 signalrgb-python\n\n\u003cdiv align=\"center\"\u003e\n\n[![CI](https://github.com/hyperb1iss/signalrgb-python/actions/workflows/ci.yml/badge.svg)](https://github.com/hyperb1iss/signalrgb-python/actions/workflows/ci.yml)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![PyPI version](https://img.shields.io/pypi/v/signalrgb)](https://pypi.org/project/signalrgb)\n[![Python](https://img.shields.io/pypi/pyversions/signalrgb)](https://pypi.org/project/signalrgb)\n\n_A Python client library and CLI for controlling [SignalRGB Pro](https://signalrgb.com)_\n\n[Features](#features) • [Installation](#installation) • [Usage](#usage) •\n[API Reference](#api-reference) • [Development](#development) • [Contributing](#contributing) •\n[License](#license)\n\n\u003c/div\u003e\n\n## 🌟 Features\n\n\u003ca name=\"features\"\u003e\u003c/a\u003e\n\n- List available lighting effects, presets, and layouts\n- Apply effects, presets, and layouts to your devices\n- Control canvas brightness and enabled state\n- Synchronous client for scripts and tools\n- Asynchronous client (httpx) for asyncio apps and Home Assistant integrations\n- Rich-powered CLI with intuitive subcommands (`effect`, `preset`, `layout`, `canvas`)\n- Effect caching and robust exception types for connection, API, and not-found errors\n\n## 💎 Installation\n\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\n\n```bash\n# with uv (recommended)\nuv add signalrgb\n\n# or with pip\npip install signalrgb\n```\n\n### Prerequisites\n\n- Python **3.13+**\n- [SignalRGB Pro](https://www.signalrgb.com/pro/) — required for API access\n\nThis library uses the [SignalRGB REST API](https://docs.signalrgb.com/signalrgb-api), which is only\navailable in SignalRGB Pro.\n\n## 🎯 Usage\n\n\u003ca name=\"usage\"\u003e\u003c/a\u003e\n\n### Command-line interface\n\nThe CLI is a Rich + Typer app with category subcommands for effects, presets, layouts, and canvas\ncontrol.\n\n```bash\n# Effects\nsignalrgb effect list\nsignalrgb effect \"Psychedelic Dream\"\nsignalrgb effect apply \"Rave Visualizer\"\nsignalrgb effect random\nsignalrgb effect search \"ocean\"\n\n# Presets\nsignalrgb preset list\nsignalrgb preset apply \"My Fancy Preset\"\n\n# Layouts\nsignalrgb layout list\nsignalrgb layout set \"My Gaming Layout\"\n\n# Canvas\nsignalrgb canvas                     # show state + brightness\nsignalrgb canvas brightness 75       # set brightness\nsignalrgb canvas brightness          # read brightness\nsignalrgb canvas enable\nsignalrgb canvas disable\nsignalrgb canvas toggle\n```\n\nPoint at a remote SignalRGB instance:\n\n```bash\nsignalrgb --host hyperia.home --port 16038 effect list\n```\n\nFull help:\n\n```bash\nsignalrgb --help\n```\n\n### Synchronous client\n\n```python\nfrom signalrgb import SignalRGBClient\n\nclient = SignalRGBClient(host=\"hyperia.home\", port=16038)\n\n# List effects\nfor effect in client.get_effects():\n    print(effect.attributes.name)\n\n# Apply an effect and a preset\nclient.apply_effect_by_name(\"Rain\")\ncurrent = client.get_current_effect()\nclient.apply_effect_preset(current.id, \"Cool Preset\")\n\n# Canvas control\nclient.brightness = 50\nclient.enabled = True\n```\n\n### Asynchronous client\n\nFor async apps and Home Assistant integrations, use `AsyncSignalRGBClient` as an async context\nmanager:\n\n```python\nimport asyncio\nfrom signalrgb import AsyncSignalRGBClient\n\nasync def main() -\u003e None:\n    async with AsyncSignalRGBClient(host=\"hyperia.home\", port=16038) as client:\n        for effect in await client.get_effects():\n            print(effect.attributes.name)\n\n        await client.apply_effect_by_name(\"Rain\")\n        await client.set_brightness(75)\n        await client.set_enabled(True)\n\n        current = await client.get_current_effect()\n        print(f\"Current effect: {current.attributes.name}\")\n\nasyncio.run(main())\n```\n\nSee the [Async Client reference](https://hyperb1iss.github.io/signalrgb-python/reference/async) for the full async guide.\n\n### Error handling\n\n```python\nfrom signalrgb import SignalRGBClient, ConnectionError, APIError, NotFoundError\n\nclient = SignalRGBClient()\n\ntry:\n    client.apply_effect_by_name(\"Non-existent Effect\")\nexcept ConnectionError as e:\n    print(f\"Connection failed: {e}\")\nexcept NotFoundError as e:\n    print(f\"Effect not found: {e}\")\nexcept APIError as e:\n    print(f\"API error: {e}\")\n```\n\nThe same pattern works with the async client.\n\n## 🔮 API Reference\n\n\u003ca name=\"api-reference\"\u003e\u003c/a\u003e\n\nFull API docs are published at **\u003chttps://hyperb1iss.github.io/signalrgb-python/\u003e**.\n\n## 🧪 Development\n\n\u003ca name=\"development\"\u003e\u003c/a\u003e\n\nThe project uses the Astral stack: **uv** for packaging, **ruff** for lint + format, **ty** for type\nchecking, and **pytest** for tests. All common tasks are wired up in the `justfile`.\n\n```bash\n# Clone and set up\ngit clone https://github.com/hyperb1iss/signalrgb-python.git\ncd signalrgb-python\n\n# Install everything (runtime + dev + docs)\njust install\n\n# Run the full check suite (lint, format, typecheck, tests)\njust verify\n\n# Or the fast loop (auto-fix then test)\njust check\n\n# Other common tasks\njust test              # pytest with coverage\njust lint-fix          # ruff check --fix\njust fmt               # ruff format\njust typecheck         # ty check\njust docs-serve        # mkdocs on :8000\njust run effect list   # run the CLI\njust --list            # see everything\n```\n\nSee the [Development Guide](https://hyperb1iss.github.io/signalrgb-python/development/) for the full\nworkflow.\n\n## 🦋 Contributing\n\n\u003ca name=\"contributing\"\u003e\u003c/a\u003e\n\nContributions are welcome. Fork, branch, and open a PR:\n\n1. Fork the repository\n2. Create a branch: `git checkout -b my-feature`\n3. `just verify` should pass before you push\n4. Open a pull request\n\nPlease include tests for new functionality and follow the existing code style (ruff + ty will tell\nyou if anything's off).\n\n## 📄 License\n\n\u003ca name=\"license\"\u003e\u003c/a\u003e\n\nApache License 2.0 — see [LICENSE](LICENSE).\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n[Documentation](https://hyperb1iss.github.io/signalrgb-python/) •\n[Report a bug](https://github.com/hyperb1iss/signalrgb-python/issues) •\n[Request a feature](https://github.com/hyperb1iss/signalrgb-python/issues)\n\n\u003c/div\u003e\n\n## 💜 Acknowledgements\n\nThis project is not officially associated with SignalRGB. It is an independent community client —\nplease do not report client issues to the SignalRGB team.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\nCreated by [Stefanie Jane](https://github.com/hyperb1iss)\n\nIf you find this project useful, consider\n[buying me a Monster Ultra Violet](https://ko-fi.com/hyperb1iss).\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperb1iss%2Fsignalrgb-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperb1iss%2Fsignalrgb-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperb1iss%2Fsignalrgb-python/lists"}