python-cnb 0.1.0__tar.gz

python_cnb-0.1.0/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-present, cnb.cool
+
+Permission is hereby granted, free of charge, to any person obtaining 
+a copy of this software and associated documentation files (the “Software”), 
+to deal in the Software without restriction, including without limitation 
+the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+and/or sell copies of the Software, and to permit persons to whom 
+the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be 
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS 
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

python_cnb-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+include README.md

python_cnb-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: python-cnb
+Version: 0.1.0
+Summary: CNB OpenAPI的Python SDK,方便与CNB平台进行交互
+Home-page: https://cnb.cool
+Author: Tencent Cloud
+Author-email: ericdduan@tencent.com
+License: MIT
+Project-URL: Source, https://cnb.cool/cnb/sdk/python-cnb
+Project-URL: Documentation, https://cnb.cool/docs
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: python-dotenv>=0.21.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Python CNB OpenAPI SDK
+
+[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+<a href="https://yuanbao.tencent.com"><img src="https://img.shields.io/badge/AI-Code%20Assist-EB9FDA"></a>
+
+CNB OpenAPI的Python SDK，方便与CNB平台进行交互。
+> 该 sdk 由 [cnb-sdk-generator](https://cnb.cool/cnb/sdk/cnb-sdk-generator) 生成
+
+## 功能特性
+
+- 完整的API覆盖（用户、仓库、Issue等）
+- 基于Pydantic的强类型模型
+- 完善的错误处理机制
+- 自动重试和超时控制
+
+## 安装
+
+```bash
+pip install -e .
+```
+
+或通过PyPI安装（发布后）：
+
+```bash
+pip install python-cnb
+```
+
+## 快速开始
+
+```python
+def sync_api_demo():
+    # 初始化客户端
+    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}")
+
+    except CNBAPIError as e:
+        print(f"API调用失败: {e}")
+
+if __name__ == "__main__":
+    sync_api_demo()
+
+```
+
+
+## 配置
+
+在项目根目录创建`.env`文件：
+
+```ini
+API_KEY=your_cnb_api_key
+BASE_URL=https://api.cnb.cool
+```
+
+## 许可证
+
+MIT License - 详见[LICENSE](LICENSE)文件

python_cnb-0.1.0/README.md

@@ -0,0 +1,65 @@
+# Python CNB OpenAPI SDK
+
+[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+<a href="https://yuanbao.tencent.com"><img src="https://img.shields.io/badge/AI-Code%20Assist-EB9FDA"></a>
+
+CNB OpenAPI的Python SDK，方便与CNB平台进行交互。
+> 该 sdk 由 [cnb-sdk-generator](https://cnb.cool/cnb/sdk/cnb-sdk-generator) 生成
+
+## 功能特性
+
+- 完整的API覆盖（用户、仓库、Issue等）
+- 基于Pydantic的强类型模型
+- 完善的错误处理机制
+- 自动重试和超时控制
+
+## 安装
+
+```bash
+pip install -e .
+```
+
+或通过PyPI安装（发布后）：
+
+```bash
+pip install python-cnb
+```
+
+## 快速开始
+
+```python
+def sync_api_demo():
+    # 初始化客户端
+    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}")
+
+    except CNBAPIError as e:
+        print(f"API调用失败: {e}")
+
+if __name__ == "__main__":
+    sync_api_demo()
+
+```
+
+
+## 配置
+
+在项目根目录创建`.env`文件：
+
+```ini
+API_KEY=your_cnb_api_key
+BASE_URL=https://api.cnb.cool
+```
+
+## 许可证
+
+MIT License - 详见[LICENSE](LICENSE)文件

python_cnb-0.1.0/cnb/__init__.py

@@ -0,0 +1,7 @@
+from .client import CNBClient
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "CNBClient",
+]

python_cnb-0.1.0/cnb/artifactory.py

@@ -0,0 +1,205 @@
+# Code generated by cnb.cool/cnb/sdk/cnb-sdk-generator. DO NOT EDIT.
+# versions:
+#    cnb-sdk-generator: 1.0.2
+# source: https://api.cnb.cool/swagger.json
+
+from typing import Optional
+from .models import dto
+class ArtifactoryService:    
+	def __init__(self, client):
+		self._client = client
+
+	# 删除制品标签。 Delete the specific tag under specific package
+	def delete_package_tag(self,
+		slug: str,
+		t: str,
+		name: str,
+		tag: str,
+	    ):
+		u = "/%s/-/packages/%s/%s/-/tag/%s" % (slug, t, name, tag, )
+
+		data = self._client.request(
+			method="DELETE", 
+			endpoint=u,
+			)
+		return 
+
+	# 删除制品仓库。Delete the artifact repository.
+	def delete_registry(self,
+		registry: str,
+	    ):
+		u = "/%s" % (registry, )
+
+		data = self._client.request(
+			method="DELETE", 
+			endpoint=u,
+			)
+		return 
+
+	# 下载制品配额信息。 Download registry quota details.
+	def download_quotas_by_project_name(self,
+		slug: str,
+		t: str,
+	    page: Optional[int] = None,
+		page_size: Optional[int] = None,
+		ordering: Optional[str] = None,
+		) -> list[dto.QuotaRsp]:
+		u = "/%s/-/packages/%s/-/quotas/download" % (slug, t, )
+
+		query_params = {
+			"page": page,
+			"page_size": page_size,
+			"ordering": ordering,
+			}
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			params=query_params,
+			)
+		return [dto.QuotaRsp.safe_parse(item) for item in data]
+
+	# 获取某一制品的详细信息。 Get the package detail.
+	def get_package(self,
+		slug: str,
+		t: str,
+		name: str,
+	    ) -> dto.PackageDetail:
+		u = "/%s/-/packages/%s/%s" % (slug, t, name, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return dto.PackageDetail.safe_parse(data)
+
+	# 获取制品标签详情。 Get the specific tag under specific package.
+	def get_package_tag_detail(self,
+		slug: str,
+		t: str,
+		name: str,
+		tag: str,
+	    sha256: Optional[str] = None,
+		) -> dto.TagDetail:
+		u = "/%s/-/packages/%s/%s/-/tag/%s" % (slug, t, name, tag, )
+
+		query_params = {
+			"sha256": sha256,
+			}
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			params=query_params,
+			)
+		return dto.TagDetail.safe_parse(data)
+
+	# 查询制品配额。 Get quota of specific registry.
+	def get_quota_by_project_name(self,
+		slug: str,
+		t: str,
+	    ) -> dto.QuotaRsp:
+		u = "/%s/-/packages/%s/-/quota" % (slug, t, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return dto.QuotaRsp.safe_parse(data)
+
+	# 查询全部制品配额。 Get quotas of packages under one registry.
+	def get_quotas_by_project_name(self,
+		slug: str,
+		t: str,
+	    page: Optional[int] = None,
+		page_size: Optional[int] = None,
+		ordering: Optional[str] = None,
+		) -> list[dto.QuotaRsp]:
+		u = "/%s/-/packages/%s/-/quotas" % (slug, t, )
+
+		query_params = {
+			"page": page,
+			"page_size": page_size,
+			"ordering": ordering,
+			}
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			params=query_params,
+			)
+		return [dto.QuotaRsp.safe_parse(item) for item in data]
+
+	# 查询制品数量。 Head all packages.
+	def head_packages(self,
+		slug: str,
+	    type: Optional[str] = None,
+		page: Optional[int] = None,
+		page_size: Optional[int] = None,
+		ordering: Optional[str] = None,
+		name: Optional[str] = None,
+		):
+		u = "/%s/-/packages" % (slug, )
+
+		query_params = {
+			"type": type,
+			"page": page,
+			"page_size": page_size,
+			"ordering": ordering,
+			"name": name,
+			}
+		data = self._client.request(
+			method="HEAD", 
+			endpoint=u,
+			params=query_params,
+			)
+		return 
+
+	# 查询制品标签列表。 List all tags under specific package.
+	def list_package_tags(self,
+		slug: str,
+		t: str,
+		pkgname: str,
+	    page: Optional[int] = None,
+		page_size: Optional[int] = None,
+		ordering: Optional[str] = None,
+		name: Optional[str] = None,
+		) -> dto.Tag:
+		u = "/%s/-/packages/%s/%s/-/tags" % (slug, t, pkgname, )
+
+		query_params = {
+			"page": page,
+			"page_size": page_size,
+			"ordering": ordering,
+			"name": name,
+			}
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			params=query_params,
+			)
+		return dto.Tag.safe_parse(data)
+
+	# 查询制品列表。 List all packages.
+	def list_packages(self,
+		slug: str,
+	    type: Optional[str] = None,
+		page: Optional[int] = None,
+		page_size: Optional[int] = None,
+		ordering: Optional[str] = None,
+		name: Optional[str] = None,
+		) -> list[dto.Package]:
+		u = "/%s/-/packages" % (slug, )
+
+		query_params = {
+			"type": type,
+			"page": page,
+			"page_size": page_size,
+			"ordering": ordering,
+			"name": name,
+			}
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			params=query_params,
+			)
+		return [dto.Package.safe_parse(item) for item in data]
+
+	

python_cnb-0.1.0/cnb/assets.py

@@ -0,0 +1,219 @@
+# Code generated by cnb.cool/cnb/sdk/cnb-sdk-generator. DO NOT EDIT.
+# versions:
+#    cnb-sdk-generator: 1.0.2
+# source: https://api.cnb.cool/swagger.json
+
+from typing import Optional
+from .models import dto
+class AssetsService:    
+	def __init__(self, client):
+		self._client = client
+
+	# 发起一个获取 commits 附件的请求，返回内容或者 302 到某个地址。Get a request to fetch a commit assets and returns the content directly or a 302 redirect to the assets URL.
+	def get_commit_assets(self,
+		repo: str,
+		fileName: str,
+	    ):
+		u = "/%s/-/commit-assets/download/%s" % (repo, fileName, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return 
+
+	# 发起一个获取 files 的请求，返回内容或者 302 到某个地址。Initiate a request to retrieve files, returns content or 302 redirect.
+	def get_files(self,
+		repo: str,
+		userIdKey: str,
+		randomUUID: str,
+		fileName: str,
+	    ):
+		u = "/%s/-/files/%s/%s/%s" % (repo, userIdKey, randomUUID, fileName, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return 
+
+	# 发起一个获取 imgs 的请求，返回内容或者 302 到某个地址。Initiate a request to get images, returns content or 302 redirect.
+	def get_imgs(self,
+		repo: str,
+		userIdKey: str,
+		fileName: str,
+	    ):
+		u = "/%s/-/imgs/%s/%s" % (repo, userIdKey, fileName, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return 
+
+	# 发起一个获取 latest release 附件的请求，返回内容或者 302 到某个地址。Initiate a request to get latest release attachments, returns content or 302 redirect.
+	def get_latest_releases_asset(self,
+		repo: str,
+		fileName: str,
+	    ):
+		u = "/%s/-/releases/latest/download/%s" % (repo, fileName, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return 
+
+	# 发起一个获取 logo 的请求，返回内容或者 302 到某个地址。Post a request to fetch a logo and returns the content directly or a 302 redirect to the logo URL.
+	def get_logos(self,
+		group: str,
+		size: str,
+	    ):
+		u = "/%s/-/logos/%s" % (group, size, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return 
+
+	# 发起一个获取 release 附件的请求，返回内容或者 302 到某个地址。Initiate a request to get release attachments, returns content or 302 redirect.
+	def get_releases_asset(self,
+		repo: str,
+		fileName: str,
+	    ):
+		u = "/%s/-/releases/download/%s" % (repo, fileName, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return 
+
+	# 获取指定用户的用户头像。Get the user's avatar.
+	def get_user_avatar(self,
+		username: str,
+		size: str,
+	    ):
+		u = "/users/%s/avatar/%s" % (username, size, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return 
+
+	# 发起一个确认 files 的请求，上传的图片要调用此接口才能生效。Initiate a request to confirm files, uploaded images need to call this API to take effect.
+	def put_files(self,
+		repo: str,
+		userIdKey: str,
+		randomUUID: str,
+		fileName: str,
+	    token: Optional[str] = None,
+		):
+		u = "/%s/-/files/%s/%s/%s" % (repo, userIdKey, randomUUID, fileName, )
+
+		query_params = {
+			"token": token,
+			}
+		data = self._client.request(
+			method="PUT", 
+			endpoint=u,
+			params=query_params,
+			)
+		return 
+
+	# 发起一个确认 imgs 的请求，上传的图片要调用此接口才能生效。Initiate a request to confirm images, uploaded images need to call this API to take effect.
+	def put_imgs(self,
+		repo: str,
+		userIdKey: str,
+		fileName: str,
+	    token: Optional[str] = None,
+		):
+		u = "/%s/-/imgs/%s/%s" % (repo, userIdKey, fileName, )
+
+		query_params = {
+			"token": token,
+			}
+		data = self._client.request(
+			method="PUT", 
+			endpoint=u,
+			params=query_params,
+			)
+		return 
+
+	# 确认上传的logo。Confirms the uploaded logo.
+	def put_logos(self,
+		group: str,
+	    token: Optional[str] = None,
+		):
+		u = "/%s/-/logos" % (group, )
+
+		query_params = {
+			"token": token,
+			}
+		data = self._client.request(
+			method="PUT", 
+			endpoint=u,
+			params=query_params,
+			)
+		return 
+
+	# 发起一个上传 files 的请求，返回上传 cos 的 url 和 form 内容。Initiate a request to upload files,returns COS upload URL and form data.
+	def upload_files(self,
+		repo: str,
+	    body_params: dto.UploadRequestParams,
+		) -> dto.UploadAssetsResponse:
+		u = "/%s/-/upload/files" % (repo, )
+
+		data = self._client.request(
+			method="POST", 
+			endpoint=u,
+			json=body_params.to_dict(),
+			)
+		return dto.UploadAssetsResponse.safe_parse(data)
+
+	# 发起一个上传 imgs 的请求，返回上传 cos 的 url 和 form 内容。发起一个上传 imgs 的请求，返回上传 cos 的 url 和 form 内容.
+	def upload_imgs(self,
+		repo: str,
+	    body_params: dto.UploadRequestParams,
+		) -> dto.UploadAssetsResponse:
+		u = "/%s/-/upload/imgs" % (repo, )
+
+		data = self._client.request(
+			method="POST", 
+			endpoint=u,
+			json=body_params.to_dict(),
+			)
+		return dto.UploadAssetsResponse.safe_parse(data)
+
+	# 发起一个上传 logo 的请求，返回上传 cos 的 url 和 form 内容。Post a request to upload a logo.
+	def upload_logos(self,
+		group: str,
+	    body_params: dto.UploadRequestParams,
+		) -> dto.UploadAssetsResponse:
+		u = "/%s/-/upload/logos" % (group, )
+
+		data = self._client.request(
+			method="POST", 
+			endpoint=u,
+			json=body_params.to_dict(),
+			)
+		return dto.UploadAssetsResponse.safe_parse(data)
+
+	# 发起一个上传 release 附件的请求，返回上传 cos 的 url 和 form 内容。Initiate a request to upload release attachments, returns COS upload URL and form data.
+	def upload_releases(self,
+		repo: str,
+		tagName: str,
+	    body_params: dto.UploadRequestParams,
+		) -> dto.UploadAssetsResponse:
+		u = "/%s/-/upload/releases/%s" % (repo, tagName, )
+
+		data = self._client.request(
+			method="POST", 
+			endpoint=u,
+			json=body_params.to_dict(),
+			)
+		return dto.UploadAssetsResponse.safe_parse(data)
+
+