WLED的异步Python客户端。
项目描述
Python: WLED API客户端
WLED的异步Python客户端。
关于
此软件包允许您以编程方式控制和监控WLED设备。它主要创建用于允许第三方程序自动化WLED的行为。
安装
pip install wled
用法
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())
更新日志和发布
此存储库使用GitHub的发布功能维护更改日志。
发布基于语义版本化，并使用MAJOR.MINOR.PATCH格式。简而言之，版本号将根据以下情况进行增加：
MAJOR：不兼容或主要更改。MINOR：向后兼容的新功能和增强。PATCH：向后兼容的错误修复和软件包更新。
贡献
这是一个活跃的开源项目。我们始终欢迎希望使用代码或为其做出贡献的人。
我们已为我们的贡献指南设置了单独的文档。
感谢您的参与！ :heart_eyes
设置开发环境
开始最简单的方法是在GitHub上打开一个CodeSpace，或者使用Visual Studio Code的Dev Container功能。
此Python项目完全使用Poetry依赖项管理器进行管理。但开发过程中也依赖于NodeJS进行某些检查。
您需要至少
- Python 3.11+
- Poetry
- NodeJS 20+（包括NPM）
安装所有包，包括所有开发需求
npm install
poetry install --extras cli
由于此存储库使用pre-commit框架，所有更改在每个提交时都会进行代码审查和测试。您可以使用以下命令手动运行所有检查和测试
poetry run pre-commit run --all-files
仅运行Python测试
poetry run pytest
作者与贡献者
此存储库的原始设置由Franck Nijhof完成。
要查看所有作者和贡献者的完整列表，请参阅贡献者页面。
许可证
MIT许可
版权所有 © 2019-2024 Franck Nijhof
特此授予任何获得本软件及其相关文档文件（“软件”）副本的人免费使用该软件的权利，不受限制地处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许将软件提供给任何获得软件的人以这样做，前提是遵守以下条件
上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。
软件按“现状”提供，不提供任何形式的保证，明示或暗示，包括但不限于适销性、适用于特定目的和无侵权性的保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论是在合同、侵权或其他情况下，是否因软件或其使用或其他方式而产生。
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。