croupier-sdk 0.1.0

Croupier Python SDK for Game Function Registration and File Transfer

Croupier Python SDK

同步 Python SDK，用于 Croupier 游戏函数注册与执行系统

---

简介

Croupier Python SDK 是 Croupier 游戏后端平台的官方 Python 客户端实现。它提供了同步的 gRPC 通信、心跳维护、线程安全的作业状态管理以及 Provider Manifest 上传功能。

系统要求

• Python ≥ 3.12
• grpcio, protobuf

安装

使用 pip（传统方式）

cd sdks/python
python -m venv .venv
source .venv/bin/activate
python -m pip install -U pip
python -m pip install -e .

使用 uv（推荐，更快速）

pip install uv
cd croupier-sdk-python
uv sync --dev --all-extras

快速开始

import json
from croupier import CroupierClient, ClientConfig, FunctionDescriptor

config = ClientConfig(
    agent_addr="127.0.0.1:19090",
    control_addr="127.0.0.1:18080",
    service_id="python-demo",
    service_version="1.0.0",
)

client = CroupierClient(config)

def player_ban(_context: str, payload: bytes) -> str:
    req = json.loads(payload.decode("utf-8"))
    return json.dumps({
        "status": "ok",
        "player_id": req["player_id"],
    })

client.register_function(FunctionDescriptor(id="player.ban", version="1.0.0"), player_ban)
client.connect()
print("✅ python-demo 已注册并正在服务 gRPC 流量")

开发指南

使用 uv 开发（推荐）

pip install uv
uv sync --dev --all-extras
uv run pytest
uv run python examples/main.py
uv build

使用 pip 开发

python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
python -m pytest
python examples/main.py

其他语言 SDK

语言	仓库	Nightly	Release	Docs	Coverage
C++	croupier-sdk-cpp
Go	croupier-sdk-go
Java	croupier-sdk-java
JS/TS	croupier-sdk-js
C#	croupier-sdk-csharp
Lua	croupier-sdk-cpp	-	-		-

贡献指南

1. 确保所有类型与 proto 定义对齐
2. 为新功能添加测试
3. 更新 API 变更的文档
4. 遵循 Python 编码规范（PEP 8）

欢迎贡献！请随时提交 issue 或 PR。💡

许可证

本项目采用 Apache License 2.0 开源协议。

---

🏠 主项目 • 🐛 问题反馈 • 💬 讨论区