Python: PVOutput API 的异步客户端

PVOutput API 的异步客户端。

关于

此软件包允许您以编程方式监视连接到 PVOutput 的 PV 系统。它主要是为了允许第三方程序与 PVOutput 集成。

安装

pip install pvo

使用

import asyncio

from pvo import PVOutput


async def main():
    """Show example on using the PVOutput API client."""
    async with PVOutput(
        api_key="API_KEY_FROM_PVOUTPUT_ORG",
        system_id=60017,
    ) as pvoutput:
        status = await pvoutput.status()
        print(status)


if __name__ == "__main__":
    asyncio.run(main())

变更日志 & 发布

此仓库使用 GitHub 的发布功能 维护变更日志。日志格式基于 Keep a Changelog。

发布基于 语义版本控制，并使用 MAJOR.MINOR.PATCH 格式。简而言之，版本号将根据以下进行增加：

• MAJOR：不兼容或主要更改。
• MINOR：向后兼容的新功能和增强。
• PATCH：向后兼容的错误修复和软件包更新。

贡献

这是一个活跃的开源项目。我们始终欢迎想要使用或贡献代码的人。

我们为我们的贡献指南设置了一个单独的文档。

感谢您的参与！:heart_eyes

设置开发环境

最简单的方法是在GitHub上打开CodeSpace，或者使用Visual Studio Code的开发容器功能。

此Python项目完全使用Poetry依赖项管理器进行管理。但开发过程中也依赖于NodeJS进行某些检查。

您至少需要

• Python 3.11+
• Poetry
• NodeJS 18+（包括NPM）

安装所有包，包括所有开发需求

npm install
poetry install

由于此存储库使用pre-commit框架，每次提交都会对所有更改进行lint和测试。您可以使用以下命令手动运行所有检查和测试

poetry run pre-commit run --all-files

仅运行Python测试

poetry run pytest

作者和贡献者

此存储库的原始设置由Franck Nijhof完成。

要查看所有作者和贡献者的完整列表，请查看贡献者页面。

许可证

MIT许可证

版权（c）2023 Franck Nijhof

特此授予任何获得此软件及其相关文档文件（“软件”）副本的任何人免费处理软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，并允许向软件提供的人这样做，但受以下条件约束

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、针对特定目的的适用性和非侵权性保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论这些责任是因合同、侵权或其他原因引起的，以及与软件或软件的使用或其他方式有关或相关。