Metadata-Version: 2.4
Name: tianjian-api
Version: 0.1.0
Summary: Python SDK for Tianjian API platform
Author: Tianjian API
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.28

# Tianjian API Python SDK

简洁同步版 SDK，适合服务端脚本、业务系统和定时任务接入。它是独立 Python 第三方库，不改变网站现有业务接口。

## 安装

```bash
pip install -e .
```

## 快速开始

```python
from tianjian_api import TianjianClient

client = TianjianClient(
    api_key="你的 API KEY",
    base_url="https://ocr.ikunocr.cn",
    type="api",
    proxy="http://127.0.0.1:7890",  # SDK 请求平台时使用的网络代理，可不填
    timeout=10,
)

res = client.call("16hangzhoudxdx", c="xxx", api_proxy="http://user:pass@ip:port/")
print(res)
```

## 常用能力

- `client.call(path, **params)` 调用任意产品接口，自动携带 `key`。
- `client.get(path, **params)` 使用 GET 调用产品接口。
- `client.post(path, **params)` 使用 POST 调用产品接口。
- `client.balance()` 查询余额，需要平台提供 API KEY 查询接口后配置 `balance_path`。
- `client.packages()` 查询当前用户套餐，需要平台提供 API KEY 查询接口后配置 `packages_path`。

注意：`proxy` 是 SDK 自己访问平台时使用的网络代理；`api_proxy` 是传给平台产品接口的业务代理参数，未传时不会发送该字段。

## 查询余额和套餐

如果后续平台开放查询接口，例如：

```text
GET /api/account/balance/get?key=你的密钥
GET /api/account/packages/get?key=你的密钥
```

SDK 可以这样接入：

```python
client = TianjianClient(
    api_key="你的 API KEY",
    base_url="https://ocr.ikunocr.cn",
    balance_path="account/balance",
    packages_path="account/packages",
)

print(client.balance())
print(client.packages())
```

这样第三方库保持独立，网站什么时候开放查询能力，SDK 就什么时候启用。
