CNB OpenAPI的Python SDK,方便与CNB平台进行交互
Project description
Python CNB OpenAPI SDK
CNB OpenAPI的Python SDK,方便与CNB平台进行交互。
该 sdk 由 cnb-sdk-generator 生成
功能特性
- 完整的API覆盖(用户、仓库、Issue等)
- 基于Pydantic的强类型模型
- 完善的错误处理机制
- 自动重试和超时控制
安装
pip install -e .
或通过PyPI安装(已发布):
pip install python-cnb
快速开始
#!/usr/bin/env python
import os
from dotenv import load_dotenv
from cnb import CNBClient
from cnb.exceptions import CNBAPIError
from cnb.models import api
# 加载环境变量
load_dotenv()
def get_user_info():
# 初始化客户端
client = CNBClient(
base_url="https://api.cnb.cool",
api_key=os.getenv("CNB_TOKEN"), # 从环境变量获取API Key
max_retries=3, # 最大重试次数
timeout=30, # 请求超时时间(秒)
)
try:
user_info = client.cnb.users.get_user_info()
print(f"user_info: {user_info}")
except CNBAPIError as e:
print(f"API调用失败: {e}")
def create_issue():
# 初始化客户端
client = CNBClient(
base_url="https://api.cnb.cool",
api_key=os.getenv("CNB_TOKEN"), # 从环境变量获取API Key
max_retries=3, # 最大重试次数
timeout=30, # 请求超时时间(秒)
)
try:
issue = client.cnb.issues.create_issue(
repo="looc/test-ci",
body_params=api.PostIssueForm(
title="测试 Issue",
priority="111"
)
)
print(f"issue: {issue}")
except CNBAPIError as e:
print(f"API调用失败: {e.errcode}")
if __name__ == "__main__":
get_user_info()
list_issues()
许可证
MIT License - 详见LICENSE文件
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python_cnb-1.22.12.tar.gz
(38.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file python_cnb-1.22.12.tar.gz.
File metadata
- Download URL: python_cnb-1.22.12.tar.gz
- Upload date:
- Size: 38.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
419f41956b20bc2d6dd2d34b345b92c6bf80c0f95ef3852fd1130fefc1dd808c
|
|
| MD5 |
b39afbe638e6fdc45634339f34793f51
|
|
| BLAKE2b-256 |
7afe88b6ae2e38a975a621b06f7ddc172bc5998ad847fe4a7c7c3b21b0b27dcb
|
File details
Details for the file python_cnb-1.22.12-py3-none-any.whl.
File metadata
- Download URL: python_cnb-1.22.12-py3-none-any.whl
- Upload date:
- Size: 57.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e1204e92914abd3ca858848f9d9a0cc218f3c421a3f6a138d677d91bb44f6334
|
|
| MD5 |
5ea78afbd7333220823ed294c1c14feb
|
|
| BLAKE2b-256 |
39a7806818615825c0ae4dcd936e0e5209bc8d9d8318b4b5a6067aa8e177d879
|