Python: WAQI

WAQI API的异步Python客户端。

关于

此软件包允许您请求关于全球空气质量的数据。

安装

pip install aiowaqi

使用

import asyncio

from aiowaqi import WAQIClient


async def main() -> None:
    """Show example of fetching air quality for Utrecht."""
    async with WAQIClient() as client:
        client.authenticate("token")
        air_quality = await client.get_by_city("utrecht")
        print(air_quality)


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

变更日志 & 发布

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

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

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

贡献

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

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

感谢您的参与！ :heart_eyes

设置开发环境

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

您需要至少以下内容

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

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

npm install
poetry install

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

poetry run pre-commit run --all-files

仅运行Python测试

poetry run pytest

作者与贡献者

内容由Joost Lekkerkerker提供。

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

许可证

MIT许可证

版权（c）2023-2024 Joost Lekkerkerker

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

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

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