用于 Python 的 Cardberg 绑定

用于Cardberg的 API 的Python 库，用于处理礼品卡。

绑定当前允许您：

1. 获取特定卡的信息
2. 在特定卡上创建交易

Cardberg 的 API 的详细信息可以在他们的网站上找到。如果您觉得需要涵盖其他 API 方法，请打开问题或创建拉取请求。

设置

您可以使用以下方法安装此软件包pip：

pip install cardberg

如果你喜欢pipenv使用：

pipenv install cardberg

要从源代码安装，请运行：

python setup.py install

要使 API 客户端正常工作，您需要 Python 2.7+ 或 Python 3.4+。

要从项目中通过requirements文件安装，请在更新依赖项之前添加以下内容：

git+git://github.com/palosopko/cardberg-python.git#egg=cardberg

用法

首先，您需要通过提供您从提供程序获得的用户句柄和共享密钥来要求库并设置身份验证信息。

import cardberg
cardberg.api_credentials = ("partner_id", "shared_secret")

获取卡信息是通过调用来完成的cardberg.Card.get()。该方法返回一个Card对象，其中包括id、name、surname和statusavailablecredits和points。在这个Card对象上，我们可以通过调用带有交易类型、交易的十进制值和可选的账单 ID 的方法来创建交易（无论是正面的还是负面的）以供进一步参考。create_transaction()

可能的交易类型是“信用”或“积分”，具体取决于我们使用的预算。如果您想借记（例如您的用户正在购买某物），则提供负值。

例子：

import cardberg
from decimal import Decimal

cardberg.api_credentials = ("partner_id", "shared_secret")

card = cardberg.Card.get("D1nd17h")

card.create_transaction(
    cardberg.Card.TRANSACTION_CREDITS,
    Decimal("-1.00")
)

贡献

1. 检查未解决的问题或针对功能请求或错误打开新问题。
2. 分叉存储库并对主分支（或从它的分支）进行更改。
3. 发送拉取请求。

发展

在所有受支持的 Python 版本上运行所有测试：

make test

使用以下命令运行 linter：

make lint

客户端库使用 Black 进行代码格式化。在提交 PR 之前，代码必须用黑色格式化。运行格式化程序：

make fmt

变更日志

v0.2.0：2019 年 3 月 10 日

Python 3 兼容性、Black 涵盖的代码格式以及各种小修复和正式更改，以使一切变得更好。

v0.1.1：21/03/2016

从 Cardberg 的 API 返回的积分和积分添加了四舍五入到小数点后两位。

v0.1.0：14/03/2016

支持card_info和create_transactionAPI 方法的初始版本。