Skip to main content

CNB OpenAPI的Python SDK,方便与CNB平台进行交互

Project description

Python CNB OpenAPI SDK

PyPI Python Version License

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


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.20.13.tar.gz (39.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_cnb-1.20.13-py3-none-any.whl (59.0 kB view details)

Uploaded Python 3

File details

Details for the file python_cnb-1.20.13.tar.gz.

File metadata

  • Download URL: python_cnb-1.20.13.tar.gz
  • Upload date:
  • Size: 39.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for python_cnb-1.20.13.tar.gz
Algorithm Hash digest
SHA256 99a0986a557fed88cf36ada09e2209558da3db494bd9c8377a73fa0799dd2ba2
MD5 3fd2542a1b27e03f4f533dd532087a42
BLAKE2b-256 5ee4ec619a9ff8ebc06e4a4dc636f77fca65399b986893e1f8006114847fd901

See more details on using hashes here.

File details

Details for the file python_cnb-1.20.13-py3-none-any.whl.

File metadata

  • Download URL: python_cnb-1.20.13-py3-none-any.whl
  • Upload date:
  • Size: 59.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for python_cnb-1.20.13-py3-none-any.whl
Algorithm Hash digest
SHA256 a646cd8161d00b0bdb83d5fc163d5f61033f6fcda972e7c2e51bb96a07b8e2da
MD5 adae5efd9b3f11dc0fffaf1c4b5cbf4a
BLAKE2b-256 f9de0e271dfdc3237e9f1849aaf9a3019bdd366ec9f58f768ece0ace609cf563

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page