Python: Firefly

Firefly的异步Python客户端。

关于

此包允许您从您的Firefly实例中获取数据。

安装

pip install vuurvlieg

变更日志 & 发布

此仓库使用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框架，所有更改在每次提交时都会进行代码风格检查和测试。您可以使用以下命令手动运行所有检查和测试

poetry run pre-commit run --all-files

仅运行Python测试

poetry run pytest

作者和贡献者

内容由Joost Lekkerkerker提供。

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

许可证

MIT许可证

版权所有 (c) 2024 Joost Lekkerkerker

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

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

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