{"id":15063396,"url":"https://github.com/frenck/python-wled","last_synced_at":"2025-05-14T19:07:56.481Z","repository":{"id":37396796,"uuid":"218154496","full_name":"frenck/python-wled","owner":"frenck","description":"Asynchronous Python client for WLED","archived":false,"fork":false,"pushed_at":"2025-05-14T05:42:53.000Z","size":3871,"stargazers_count":133,"open_issues_count":4,"forks_count":31,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-14T06:48:07.013Z","etag":null,"topics":["api-client","asynchronous","esp8266","ledstrip","python3","wled","ws2812b"],"latest_commit_sha":null,"homepage":null,"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/frenck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","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},"funding":{"github":"frenck","patreon":"frenck","custom":"https://frenck.dev/donate/"}},"created_at":"2019-10-28T22:10:01.000Z","updated_at":"2025-05-14T05:42:55.000Z","dependencies_parsed_at":"2024-01-13T08:09:31.522Z","dependency_job_id":"8369e60c-0103-4d43-8126-e42c8cf11900","html_url":"https://github.com/frenck/python-wled","commit_stats":{"total_commits":1565,"total_committers":14,"mean_commits":"111.78571428571429","dds":0.5182108626198083,"last_synced_commit":"a6078328b9f460cfd51784b25da34e43a5a7f623"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frenck%2Fpython-wled","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frenck%2Fpython-wled/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frenck%2Fpython-wled/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frenck%2Fpython-wled/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frenck","download_url":"https://codeload.github.com/frenck/python-wled/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254121962,"owners_count":22018252,"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":["api-client","asynchronous","esp8266","ledstrip","python3","wled","ws2812b"],"created_at":"2024-09-24T23:56:09.780Z","updated_at":"2025-05-14T19:07:55.909Z","avatar_url":"https://github.com/frenck.png","language":"Python","funding_links":["https://github.com/sponsors/frenck","https://patreon.com/frenck","https://frenck.dev/donate/","https://www.patreon.com/frenck"],"categories":[],"sub_categories":[],"readme":"# Python: WLED API Client\n\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE.md)\n\n[![Build Status][build-shield]][build]\n[![Code Coverage][codecov-shield]][codecov]\n[![Quality Gate Status][sonarcloud-shield]][sonarcloud]\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\n[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]\n\n[![Support Frenck on Patreon][patreon-shield]][patreon]\n\nAsynchronous Python client for WLED.\n\n## About\n\nThis package allows you to control and monitor an WLED device\nprogrammatically. It is mainly created to allow third-party programs to automate\nthe behavior of WLED.\n\n## Installation\n\n```bash\npip install wled\n```\n\n## Usage\n\n```python\nimport asyncio\n\nfrom wled import WLED\n\n\nasync def main() -\u003e None:\n    \"\"\"Show example on controlling your WLED device.\"\"\"\n    async with WLED(\"wled-frenck.local\") as led:\n        device = await led.update()\n        print(device.info.version)\n\n        # Turn strip on, full brightness\n        await led.master(on=True, brightness=255)\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\n## Changelog \u0026 Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality.\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\nThe easiest way to start, is by opening a CodeSpace here on GitHub, or by using\nthe [Dev Container][devcontainer] feature of Visual Studio Code.\n\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\nThis Python project is fully managed using the [Poetry][poetry] dependency\nmanager. But also relies on the use of NodeJS for certain checks during\ndevelopment.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n- NodeJS 20+ (including NPM)\n\nTo install all packages, including all development requirements:\n\n```bash\nnpm install\npoetry install --extras cli\n```\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\nTo run just the Python tests:\n\n```bash\npoetry run pytest\n```\n\n## Authors \u0026 contributors\n\nThe original setup of this repository is by [Franck Nijhof][frenck].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n## License\n\nMIT License\n\nCopyright (c) 2019-2024 Franck Nijhof\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[build-shield]: https://github.com/frenck/python-wled/actions/workflows/tests.yaml/badge.svg\n[build]: https://github.com/frenck/python-wled/actions/workflows/tests.yaml\n[codecov-shield]: https://codecov.io/gh/frenck/python-wled/branch/main/graph/badge.svg\n[codecov]: https://codecov.io/gh/frenck/python-wled\n[contributors]: https://github.com/frenck/python-wled/graphs/contributors\n[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers\u0026message=Open\u0026color=blue\u0026logo=visualstudiocode\n[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/frenck/python-wled\n[frenck]: https://github.com/frenck\n[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png\n[github-sponsors]: https://github.com/sponsors/frenck\n[license-shield]: https://img.shields.io/github/license/frenck/python-wled.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg\n[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png\n[patreon]: https://www.patreon.com/frenck\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com/\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg\n[pypi]: https://pypi.org/project/wled/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/wled\n[releases-shield]: https://img.shields.io/github/release/frenck/python-wled.svg\n[releases]: https://github.com/frenck/python-wled/releases\n[semver]: http://semver.org/spec/v2.0.0.html\n[sonarcloud-shield]: https://sonarcloud.io/api/project_badges/measure?project=frenck_python-wled\u0026metric=alert_status\n[sonarcloud]: https://sonarcloud.io/summary/new_code?id=frenck_python-wled\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrenck%2Fpython-wled","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrenck%2Fpython-wled","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrenck%2Fpython-wled/lists"}