compshare-cli 0.1.2__tar.gz → 0.2.1__tar.gz

compshare_cli-0.2.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

compshare_cli-0.2.1/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: compshare-cli
+Version: 0.2.1
+Summary: Command-line client for CompShare GPU compute
+Author: CompShare
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/BennielAllan/compshare-cli
+Project-URL: Repository, https://github.com/BennielAllan/compshare-cli
+Project-URL: Changelog, https://github.com/BennielAllan/compshare-cli/blob/master/CHANGELOG.md
+Project-URL: Issues, https://github.com/BennielAllan/compshare-cli/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<9,>=8.1
+Requires-Dist: rich<15,>=13
+Requires-Dist: typer<1,>=0.12
+Requires-Dist: ucloud-sdk-python3<0.12,>=0.11.103
+Requires-Dist: urllib3<2,>=1.26.18; python_version < "3.10" and platform_system == "Darwin"
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: pytest-cov<8,>=5; extra == "dev"
+Requires-Dist: ruff<1,>=0.6; extra == "dev"
+Dynamic: license-file
+
+# CompShare CLI
+
+在终端管理优云智算 GPU 实例、镜像、云盘、US3 挂载和团队资源。
+
+- 交互式创建实例，实时查询规格、库存和价格
+- 支持批量生命周期操作、等待状态和跨地域查询
+- 支持社区/自定义镜像、云盘、团队额度与账单
+- 默认中文帮助，可切换英文；所有命令支持 JSON 输出
+- 基于官方 [`ucloud-sdk-python3`](https://github.com/ucloud/ucloud-sdk-python3)
+
+当前版本：`0.2.1`，要求 Python 3.9 或更高版本。
+
+## 安装
+
+```bash
+python -m pip install "git+https://github.com/BennielAllan/compshare-cli.git"
+compshare -h
+```
+
+本地开发：
+
+```bash
+git clone https://github.com/BennielAllan/compshare-cli.git
+cd compshare-cli
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e '.[dev]'
+```
+
+Windows 激活虚拟环境时使用：
+
+```powershell
+.\.venv\Scripts\Activate.ps1
+```
+
+## 配置
+
+```bash
+compshare config --name default
+```
+
+凭证保存在 `~/.config/compshare/config.json`，支持多个配置：
+
+```bash
+compshare config list
+compshare config use production
+compshare --profile production instance list
+```
+
+也可以使用环境变量：
+
+```bash
+export COMPSHARE_PUBLIC_KEY='...'
+export COMPSHARE_PRIVATE_KEY='...'
+```
+
+## 快速开始
+
+```bash
+# 查规格、库存和实例
+compshare instance search
+compshare instance search --gpu 4090 --image IMAGE_ID --available
+compshare instance list --all
+
+# 交互式创建
+compshare instance create
+
+# 批量操作与等待
+compshare instance stop INSTANCE_1 INSTANCE_2
+compshare instance start INSTANCE_1 INSTANCE_2
+compshare instance wait INSTANCE_1 INSTANCE_2 --state Running
+
+# SSH
+compshare instance ssh INSTANCE_ID
+```
+
+自动化创建示例：
+
+```bash
+compshare instance create \
+  --gpu 4090 \
+  --count 1 \
+  --cpu 16 \
+  --memory 64GiB \
+  --image IMAGE_ID \
+  --disk 100GiB \
+  --charge Postpay \
+  --max-price 20 \
+  --yes
+```
+
+使用 `--dry-run` 只检查库存、价格和请求，不创建资源。
+
+## 功能入口
+
+```text
+compshare instance   GPU 实例、规格、库存、价格和生命周期
+compshare image      平台、自定义、社区及共享镜像
+compshare storage    云盘和 US3 挂载
+compshare team       团队、邀请、成员额度、账单和审计
+compshare doctor     配置、鉴权、网络与 SSH 环境诊断
+```
+
+查看完整命令和参数：
+
+```bash
+compshare -h
+compshare instance -h
+compshare instance create -h
+```
+
+## 脚本调用
+
+`--json` 和 `--profile` 是全局选项，必须放在子命令前：
+
+```bash
+compshare --json instance list --status Running --all
+compshare --profile production image list --source community
+```
+
+JSON 模式不会启动交互向导。生命周期操作可使用 `--wait`、`--no-wait` 和
+`--timeout` 控制等待行为；部分批量操作失败时，CLI 返回非零退出码。
+
+Region 和 Zone 是资源参数，放在对应子命令后：
+
+```bash
+compshare instance list --region cn-sh2
+compshare instance create --zone cn-sh2-02
+```
+
+## 语言
+
+```bash
+compshare lang en
+compshare lang zh
+compshare lang       # 查看当前语言
+```
+
+也可以通过 `COMPSHARE_LANG=en` 临时覆盖。
+
+## 安全说明
+
+- 配置目录和文件分别使用 `0700`、`0600` 权限。
+- API 私钥不会出现在命令输出中。
+- `instance create` 和 `instance ssh` 会显示 API 返回的实例登录密码，请妥善保管终端输出。
+- 删除、关机、重启、重装和改配等操作默认要求确认。
+
+## 开发校验
+
+```bash
+ruff check .
+ruff format --check .
+pytest
+```
+
+公开 API 覆盖范围和版本变化见 [CHANGELOG.md](CHANGELOG.md)。

compshare_cli-0.2.1/README.md

@@ -0,0 +1,156 @@
+# CompShare CLI
+
+在终端管理优云智算 GPU 实例、镜像、云盘、US3 挂载和团队资源。
+
+- 交互式创建实例，实时查询规格、库存和价格
+- 支持批量生命周期操作、等待状态和跨地域查询
+- 支持社区/自定义镜像、云盘、团队额度与账单
+- 默认中文帮助，可切换英文；所有命令支持 JSON 输出
+- 基于官方 [`ucloud-sdk-python3`](https://github.com/ucloud/ucloud-sdk-python3)
+
+当前版本：`0.2.1`，要求 Python 3.9 或更高版本。
+
+## 安装
+
+```bash
+python -m pip install "git+https://github.com/BennielAllan/compshare-cli.git"
+compshare -h
+```
+
+本地开发：
+
+```bash
+git clone https://github.com/BennielAllan/compshare-cli.git
+cd compshare-cli
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e '.[dev]'
+```
+
+Windows 激活虚拟环境时使用：
+
+```powershell
+.\.venv\Scripts\Activate.ps1
+```
+
+## 配置
+
+```bash
+compshare config --name default
+```
+
+凭证保存在 `~/.config/compshare/config.json`，支持多个配置：
+
+```bash
+compshare config list
+compshare config use production
+compshare --profile production instance list
+```
+
+也可以使用环境变量：
+
+```bash
+export COMPSHARE_PUBLIC_KEY='...'
+export COMPSHARE_PRIVATE_KEY='...'
+```
+
+## 快速开始
+
+```bash
+# 查规格、库存和实例
+compshare instance search
+compshare instance search --gpu 4090 --image IMAGE_ID --available
+compshare instance list --all
+
+# 交互式创建
+compshare instance create
+
+# 批量操作与等待
+compshare instance stop INSTANCE_1 INSTANCE_2
+compshare instance start INSTANCE_1 INSTANCE_2
+compshare instance wait INSTANCE_1 INSTANCE_2 --state Running
+
+# SSH
+compshare instance ssh INSTANCE_ID
+```
+
+自动化创建示例：
+
+```bash
+compshare instance create \
+  --gpu 4090 \
+  --count 1 \
+  --cpu 16 \
+  --memory 64GiB \
+  --image IMAGE_ID \
+  --disk 100GiB \
+  --charge Postpay \
+  --max-price 20 \
+  --yes
+```
+
+使用 `--dry-run` 只检查库存、价格和请求，不创建资源。
+
+## 功能入口
+
+```text
+compshare instance   GPU 实例、规格、库存、价格和生命周期
+compshare image      平台、自定义、社区及共享镜像
+compshare storage    云盘和 US3 挂载
+compshare team       团队、邀请、成员额度、账单和审计
+compshare doctor     配置、鉴权、网络与 SSH 环境诊断
+```
+
+查看完整命令和参数：
+
+```bash
+compshare -h
+compshare instance -h
+compshare instance create -h
+```
+
+## 脚本调用
+
+`--json` 和 `--profile` 是全局选项，必须放在子命令前：
+
+```bash
+compshare --json instance list --status Running --all
+compshare --profile production image list --source community
+```
+
+JSON 模式不会启动交互向导。生命周期操作可使用 `--wait`、`--no-wait` 和
+`--timeout` 控制等待行为；部分批量操作失败时，CLI 返回非零退出码。
+
+Region 和 Zone 是资源参数，放在对应子命令后：
+
+```bash
+compshare instance list --region cn-sh2
+compshare instance create --zone cn-sh2-02
+```
+
+## 语言
+
+```bash
+compshare lang en
+compshare lang zh
+compshare lang       # 查看当前语言
+```
+
+也可以通过 `COMPSHARE_LANG=en` 临时覆盖。
+
+## 安全说明
+
+- 配置目录和文件分别使用 `0700`、`0600` 权限。
+- API 私钥不会出现在命令输出中。
+- `instance create` 和 `instance ssh` 会显示 API 返回的实例登录密码，请妥善保管终端输出。
+- 删除、关机、重启、重装和改配等操作默认要求确认。
+
+## 开发校验
+
+```bash
+ruff check .
+ruff format --check .
+pytest
+```
+
+公开 API 覆盖范围和版本变化见 [CHANGELOG.md](CHANGELOG.md)。

{compshare_cli-0.1.2 → compshare_cli-0.2.1}/pyproject.toml

@@ -1,14 +1,15 @@
 [build-system]
-requires = ["setuptools>=69"]
+requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "compshare-cli"
-version = "0.1.2"
+version = "0.2.1"
 description = "Command-line client for CompShare GPU compute"
 readme = "README.md"
 requires-python = ">=3.9"
-license = { text = "Apache-2.0" }
+license = "Apache-2.0"
+license-files = ["LICENSE"]
 authors = [
   { name = "CompShare" },
 ]
@@ -20,6 +21,12 @@ dependencies = [
   "urllib3>=1.26.18,<2; python_version < '3.10' and platform_system == 'Darwin'",
 ]
 
+[project.urls]
+Homepage = "https://github.com/BennielAllan/compshare-cli"
+Repository = "https://github.com/BennielAllan/compshare-cli"
+Changelog = "https://github.com/BennielAllan/compshare-cli/blob/master/CHANGELOG.md"
+Issues = "https://github.com/BennielAllan/compshare-cli/issues"
+
 [project.optional-dependencies]
 dev = [
   "pytest>=8,<10",

{compshare_cli-0.1.2 → compshare_cli-0.2.1}/src/compshare_cli/__init__.py

@@ -1,3 +1,3 @@
 """CompShare command-line client."""
 
-__version__ = "0.1.2"
+__version__ = "0.2.1"

{compshare_cli-0.1.2 → compshare_cli-0.2.1}/src/compshare_cli/actions.py

@@ -65,7 +65,29 @@ STORAGE_ACTIONS = frozenset(
     }
 )
 
-PUBLIC_ACTIONS = INSTANCE_ACTIONS | IMAGE_ACTIONS | STORAGE_ACTIONS
+TEAM_ACTIONS = frozenset(
+    {
+        "CreateCompShareTeam",
+        "CreateCompShareTeamRelation",
+        "DeleteCompShareTeam",
+        "DescribeTeamMemberOrder",
+        "DescribeTeamMemberOrderCount",
+        "DescribeTeamMemberUnpaidOrder",
+        "DescribeTeamMemberUnpaidOrderCount",
+        "DownloadTeamOrder",
+        "GetCompShareTeamInfo",
+        "ListCompShareTeam",
+        "ListCompShareTeamInvite",
+        "ListCompShareTeamJoined",
+        "ListCompShareTeamOperateLog",
+        "ListMemberProductType",
+        "SetCompShareTeamAmount",
+        "SetCompShareTeamRelation",
+        "UpdateCompShareTeam",
+    }
+)
+
+PUBLIC_ACTIONS = INSTANCE_ACTIONS | IMAGE_ACTIONS | STORAGE_ACTIONS | TEAM_ACTIONS
 
 # Documented publicly but unavailable in the production API (RetCode 161).
 UNAVAILABLE_ACTIONS = frozenset({"DescribeFavoriteImages"})