Python: Twente Milieu

Twente Milieu API的异步Python客户端。

关于

此软件包允许您以编程方式请求Twente Milieu的垃圾收集日。它主要创建来允许第三方程序使用或响应这些数据。

一个很好的例子可能是Home Assistant，它允许您编写自动化脚本，例如，在垃圾收集日早上播放Google Home公告。

安装

pip install twentemilieu

用法

import asyncio

from twentemilieu import TwenteMilieu, WasteType


async def main() -> None:
    """Show example on stats from Twente Milieu."""
    async with TwenteMilieu(post_code="1234AB", house_number=1) as twente:
        unique_id = await twente.unique_id()
        print("Unique Address ID:", unique_id)
        pickups = await twente.update()
        print("Next pickup for Non-recyclable:", pickup.get(WasteType.NON_RECYCLABLE))


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

变更日志 & 发布

此仓库使用GitHub的发布功能保持变更日志。日志的格式基于保持变更日志。

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

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

贡献

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

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

感谢您的参与！ :heart_eyes

设置开发环境

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

此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-2023 Franck Nijhof

以下条件下，任何人可以免费获得此软件及其相关文档副本（以下简称“软件”），无需许可，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，并允许获得软件的人进行此类操作，但需遵守以下条件

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

软件按“现状”提供，不提供任何形式的保证，无论是明示的、暗示的，还是与特定目的的适用性或侵权相关的保证。在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论这些责任是因合同、侵权或其他方式而产生的，并由此软件或其使用或其他方式而产生的。