Bux

Python SDK和CLI for BUX Zero (getbux.com).

功能

• 100%类型安全。
• 支持多个网络库。
• 同步和异步API。
• 开放世界假设，API的更改不会破坏库。

支持的联网库

• requests
• httpx
• aiohttp

免责声明

• 这是一个非官方库！我未与BUX B.V.有关联，不在那里工作，也不认识那里的任何人。BUX B.V.不对该库中的任何错误负责，也不提供库的使用或开发的技术支持。
• 这是一个在MIT许可协议下分发的开源软件。我不提供项目保修或技术支持。我不对您可能遇到的任何错误或问题负责。请参阅LICENSE。
• 该库使用公共API，从某种意义上讲，它是公开可用的，您只需要一个账户（由于GDPR，您拥有这个账户）就可以访问它。然而，这个API没有文档，并且可以被BUX B.V.在任何时候破坏。
• 请注意，BUX 客户协议禁止通过官方移动应用以外的任何方式下单："您只能通过移动应用程序向 BUX 提供订单"。然而，它并没有提到其他 API 端点，例如获取历史数据。因此，除了下单端点外，所有端点都是合法的。
• 因此，请自行承担风险！如果您发现了一个错误，您是唯一能够修复它的人。请记住，当您修复了某个东西时，请将其贡献回来，该项目欢迎贡献。

入门指南

安装

安装 bux 和您想使用的网络库。如果您不知道需要哪个，请使用 requests。

python3 -m pip install bux requests

获取令牌

要向 API 发送请求，您需要获取令牌。库为此提供了一个专门的 CLI 命令

python3 -m bux get-token

请保密此令牌！这是您获取 API 完全访问权限所需的所有内容。

CLI 使用

显示可用命令

python3 -m bux --help

每个命令都需要 --token 参数。您如何存储它取决于您。例如，在一个文件中

echo "MY_TOKEN" > .token
python3.9 -m bux info --token $(cat .token) NL0011540547

SDK 使用

import bux

api = bux.UserAPI(token=your_token)

me = api.me().requests()

每个 API 端点都表示为 UserAPI 的一个方法。每个这样的方法都返回一个 bux.Request 方法，它为每个受支持的网络库（requests、httpx 等）提供了一个方法。只需调用此方法即可获取结果。结果以 bux.Response 对象的形式表示，它只是一个包含一些额外类型安全属性的 dict。

请参阅 CLI 命令的源代码（bux/_commands）以获取实际用例。