Python: AdGuard Home API客户端

AdGuard Home API的异步Python客户端。

关于

此软件包允许您以编程方式控制和监视AdGuard Home实例。它主要创建用于允许第三方程序自动化AdGuard的行为。

这的例子之一可能是Home Assistant，它允许您编写自动化脚本，在孩子回家时开启家长控制。

安装

pip install adguardhome

使用

from adguardhome import AdGuardHome

import asyncio


async def main():
    """Show example how to get status of your AdGuard Home instance."""
    async with AdGuardHome("192.168.1.2") as adguard:
        version = await adguard.version()
        print("AdGuard version:", version)

        active = await adguard.protection_enabled()
        active = "Yes" if active else "No"
        print("Protection enabled?", active)

        if not active:
            print("AdGuard Home protection disabled. Enabling...")
            await adguard.enable_protection()


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

变更日志 & 发布

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

版本基于语义版本化，并使用MAJOR.MINOR.PATCH格式。简而言之，版本号将根据以下内容递增

• MAJOR：不兼容或重大更改。
• 小版本：向后兼容的新功能和增强。
• 修补程序：向后兼容的错误修复和包更新。

贡献

这是一个活跃的开源项目。我们始终欢迎希望使用代码或为其做出贡献的人。

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

感谢您的参与！ :heart_eyes

设置开发环境

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

您至少需要

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

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

npm install
poetry install

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

poetry run pre-commit run --all-files

仅运行Python测试

poetry run pytest

作者和贡献者

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

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

许可证

MIT许可证

版权所有 (c) 2019-2024 Franck Nijhof

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

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

软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、适用于特定目的和无侵权性保证。在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论此类责任基于合同、侵权或其他原因产生，无论此类责任是否与软件或其使用或其他方式相关。