# Python: WLED API Client
[![GitHub Release][releases-shield]][releases]
[![Python Versions][python-versions-shield]][pypi]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE.md)
[![Build Status][build-shield]][build]
[![Code Coverage][codecov-shield]][codecov]
[![Quality Gate Status][sonarcloud-shield]][sonarcloud]
[![Open in Dev Containers][devcontainer-shield]][devcontainer]
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
[![Support Frenck on Patreon][patreon-shield]][patreon]
Asynchronous Python client for WLED.
## About
This package allows you to control and monitor an WLED device
programmatically. It is mainly created to allow third-party programs to automate
the behavior of WLED.
## Installation
```bash
pip install wled
```
## Usage
```python
import asyncio
from wled import WLED
async def main() -> None:
"""Show example on controlling your WLED device."""
async with WLED("wled-frenck.local") as led:
device = await led.update()
print(device.info.version)
# Turn strip on, full brightness
await led.master(on=True, brightness=255)
if __name__ == "__main__":
asyncio.run(main())
```
## Changelog & Releases
This repository keeps a change log using [GitHub's releases][releases]
functionality.
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
The easiest way to start, is by opening a CodeSpace here on GitHub, or by using
the [Dev Container][devcontainer] feature of Visual Studio Code.
[![Open in Dev Containers][devcontainer-shield]][devcontainer]
This Python project is fully managed using the [Poetry][poetry] dependency
manager. But also relies on the use of NodeJS for certain checks during
development.
You need at least:
- Python 3.11+
- [Poetry][poetry-install]
- NodeJS 20+ (including NPM)
To install all packages, including all development requirements:
```bash
npm install
poetry install --extras cli
```
As this repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:
```bash
poetry run pre-commit run --all-files
```
To run just the Python tests:
```bash
poetry run pytest
```
## Authors & contributors
The original setup of this repository is by [Franck Nijhof][frenck].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
## License
MIT License
Copyright (c) 2019-2024 Franck Nijhof
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.
[build-shield]: https://github.com/frenck/python-wled/actions/workflows/tests.yaml/badge.svg
[build]: https://github.com/frenck/python-wled/actions/workflows/tests.yaml
[codecov-shield]: https://codecov.io/gh/frenck/python-wled/branch/main/graph/badge.svg
[codecov]: https://codecov.io/gh/frenck/python-wled
[contributors]: https://github.com/frenck/python-wled/graphs/contributors
[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/frenck/python-wled
[frenck]: https://github.com/frenck
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
[github-sponsors]: https://github.com/sponsors/frenck
[license-shield]: https://img.shields.io/github/license/frenck/python-wled.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
[patreon]: https://www.patreon.com/frenck
[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[pre-commit]: https://pre-commit.com/
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[pypi]: https://pypi.org/project/wled/
[python-versions-shield]: https://img.shields.io/pypi/pyversions/wled
[releases-shield]: https://img.shields.io/github/release/frenck/python-wled.svg
[releases]: https://github.com/frenck/python-wled/releases
[semver]: http://semver.org/spec/v2.0.0.html
[sonarcloud-shield]: https://sonarcloud.io/api/project_badges/measure?project=frenck_python-wled&metric=alert_status
[sonarcloud]: https://sonarcloud.io/summary/new_code?id=frenck_python-wled
Raw data
{
"_id": null,
"home_page": "https://github.com/frenck/python-wled",
"name": "py-wled",
"maintainer": "Franck Nijhof",
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": "opensource@frenck.dev",
"keywords": "wled, api, async, client",
"author": "Franck Nijhof",
"author_email": "opensource@frenck.dev",
"download_url": "https://files.pythonhosted.org/packages/33/56/ba50c7b759082007e98381663bd317235f43187d2535ba05e202108dca20/py_wled-0.1.1.tar.gz",
"platform": null,
"description": "# 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() -> 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 & 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 & 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&message=Open&color=blue&logo=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&metric=alert_status\n[sonarcloud]: https://sonarcloud.io/summary/new_code?id=frenck_python-wled\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Asynchronous Python client for WLED.",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/frenck/python-wled/issues",
"Changelog": "https://github.com/frenck/python-wled/releases",
"Documentation": "https://github.com/frenck/python-wled",
"Homepage": "https://github.com/frenck/python-wled",
"Repository": "https://github.com/frenck/python-wled"
},
"split_keywords": [
"wled",
" api",
" async",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7acb196baeba47ea66b45a864e10429c67d0d42071877cbaf12f8ea187180fa",
"md5": "228935342309bfa44996cf563c230393",
"sha256": "16176b04b20188789356d41c05b81ee6001ca68d9ad36de69253bfd79194bc2d"
},
"downloads": -1,
"filename": "py_wled-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "228935342309bfa44996cf563c230393",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 19717,
"upload_time": "2024-06-18T18:37:20",
"upload_time_iso_8601": "2024-06-18T18:37:20.932369Z",
"url": "https://files.pythonhosted.org/packages/a7/ac/b196baeba47ea66b45a864e10429c67d0d42071877cbaf12f8ea187180fa/py_wled-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3356ba50c7b759082007e98381663bd317235f43187d2535ba05e202108dca20",
"md5": "58e269265c3db159af1b3d5fc4e274c3",
"sha256": "fc7e8b0cc0e2a67d4de6b4c1e1f24d29484053ffb6ebb51544970c7d2b15d43f"
},
"downloads": -1,
"filename": "py_wled-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "58e269265c3db159af1b3d5fc4e274c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 21202,
"upload_time": "2024-06-18T18:37:30",
"upload_time_iso_8601": "2024-06-18T18:37:30.205354Z",
"url": "https://files.pythonhosted.org/packages/33/56/ba50c7b759082007e98381663bd317235f43187d2535ba05e202108dca20/py_wled-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 18:37:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "frenck",
"github_project": "python-wled",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "py-wled"
}
JSON
