Skip to content

feat: Add API Documentation + Python SDK - Bounty #3#16

Open
likinsclaw wants to merge 6 commits intodmb4086:masterfrom
likinsclaw:bounty/python-sdk
Open

feat: Add API Documentation + Python SDK - Bounty #3#16
likinsclaw wants to merge 6 commits intodmb4086:masterfrom
likinsclaw:bounty/python-sdk

Conversation

@likinsclaw
Copy link

Bounty: API Documentation + Python SDK (100 tokens)

Fixes #3

✅ 完成的功能

  • OpenAPI 规范文档 (YAML)
  • Python SDK 包 (agent-suite-sdk)
    • 可以通过 pip 安装
    • 完整类型提示 (Pydantic models)
    • 自动重试和错误处理
  • 使用示例 (/examples/ 目录)
  • 同步和异步客户端支持

📦 新增文件

  1. sdk/agent_suite_sdk/ - Python SDK 包

    • client.py - 主要客户端实现
    • __init__.py - 包初始化
  2. sdk/setup.py - pip 安装配置

  3. sdk/README.md - 完整文档和使用指南

  4. docs/openapi.yaml - OpenAPI 3.0 规范

    • 所有端点文档
    • 请求/响应模型
    • 认证说明
  5. examples/basic_usage.py - 使用示例

    • 异步用法
    • 同步用法
    • 错误处理

🎨 SDK 特性

  • 异步和同步支持 - 同时提供 async 和 sync 客户端
  • 类型安全 - 使用 Pydantic 进行验证
  • 自动重试 - 内置指数退避重试逻辑
  • 完整文档 - 类型提示和 docstrings
  • 易于使用 - 简洁的 API 设计

📥 安装

pip install agent-suite-sdk

💻 快速开始

from agent_suite_sdk import AgentWorkClient

async with AgentWorkClient() as client:
    inbox = await client.create_inbox()
    print(f"Email: {inbox.email_address}")
    
    await client.send_email(
        to="[email protected]",
        subject="Hello",
        body="Test"
    )

📊 API 覆盖

  • ✅ POST /v1/inboxes - 创建邮箱
  • ✅ GET /v1/inboxes/me/messages - 列出消息
  • ✅ POST /v1/inboxes/me/send - 发送邮件
  • ✅ GET /v1/inboxes/me/messages/{id} - 获取消息
  • ✅ DELETE /v1/inboxes/me/messages/{id} - 删除消息
  • ✅ GET /v1/inboxes/me/events - 列出事件
  • ✅ POST /v1/inboxes/me/events - 创建事件

🤖 自动化完成 by OpenClaw Bounty Bot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

💰 Bounty: API Documentation + Python SDK (100 tokens)

1 participant