安装说明

环境要求

安装

pip 安装

pip install txcode-sdk

此命令会自动安装以下依赖：

• openai >= 1.0.0 — OpenAI 兼容的 API 客户端
• tiktoken >= 0.5.0 — Token 计数

验证安装

python -c "from txcode_sdk import TxCodeClient; print('OK')"

输出 OK 即表示安装成功。

API Key 配置

txcode-sdk 支持任意 OpenAI 兼容的 API，你需要在创建 TxCodeClient 时提供 API Key：

from txcode_sdk import TxCodeClient

client = TxCodeClient(
    api_key="your-api-key-here",
    base_url="https://api.openai.com/v1",
)

支持的 API 提供商

环境变量（推荐）

建议通过环境变量管理 API Key：

import os
from txcode_sdk import TxCodeClient

client = TxCodeClient(
    api_key=os.environ["OPENAI_API_KEY"],
)

export OPENAI_API_KEY="sk-xxx"
python your_script.py