axonhub-client 0.1.0__tar.gz

axonhub_client-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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
+
+       https://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.

axonhub_client-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: axonhub-client
+Version: 0.1.0
+Summary: AxonHub 管理操作客户端与 CLI
+Author: coofly
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/coofly/axonhubclient
+Project-URL: Repository, https://github.com/coofly/axonhubclient
+Project-URL: Issues, https://github.com/coofly/axonhubclient/issues
+Keywords: axonhub,client,cli,admin,graphql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# AxonHubClient
+
+`AxonHubClient` 是用于管理 AxonHub 实例的 Python client 和命令行工具。它面向 AxonHub Admin API，通过 Admin Token 访问 `/admin/graphql`，用于盘点和管理渠道、模型、API Key / Profile、用量、请求日志、Trace 和诊断信息。
+
+## 适用场景
+
+- 查看 AxonHub 实例中的渠道、模型、用量和请求状态。
+- 批量导入、创建、更新、启停或排序渠道。
+- 管理模型和模型关联规则。
+- 检查渠道健康状态、请求日志、用量日志和 Trace。
+- 在自动化脚本或 Agent 工作流中复用同一套 AxonHub 管理操作。
+
+本项目不负责获取上游 API 资源。调用方应确保传入的 endpoint、API key 和模型信息已经获得授权。
+
+## 文档
+
+- [使用说明](docs/使用说明.md)：完整 CLI 命令、参数、确认规则和示例。
+- [示例输入](docs/examples/)：渠道、模型、排序和 endpoint 等 JSON 输入样例。
+
+## 安装
+
+推荐使用 `uv` 作为独立命令行工具安装：
+
+```bash
+uv tool install axonhub-client
+axonhub-client --help
+```
+
+升级和卸载：
+
+```bash
+uv tool upgrade axonhub-client
+uv tool uninstall axonhub-client
+```
+
+Windows 用户也可以从 GitHub Release 下载 `axonhub-client-windows-x64-vX.Y.Z.zip`，解压后直接运行：
+
+```powershell
+.\axonhub-client.exe --help
+```
+
+从源码目录开发时：
+
+```bash
+uv sync --extra dev
+uv run axonhub-client --help
+```
+
+命名约定：安装包、CLI 命令和发布产物使用 `axonhub-client`；Python import 包名使用 `axonhub_client`。
+
+## 快速开始
+
+首次使用先登录 AxonHub 管理后台。登录成功后，CLI 会把默认 session 保存到当前用户配置目录；session 文件保存实例地址、token、用户摘要和保存时间，不保存密码。
+
+```powershell
+axonhub-client auth login --url https://your-axonhub.example.com --username admin@example.com
+```
+
+上面的命令会继续提示输入密码，密码输入不会回显。需要非交互登录时，可以显式传入 `--password`：
+
+```powershell
+axonhub-client auth login --url https://your-axonhub.example.com --username admin@example.com --password "your-password"
+```
+
+`auth login` 也可以不传参数，按提示交互式输入实例地址、用户名和密码。
+
+常用盘点命令：
+
+```powershell
+axonhub-client --json inventory summary
+axonhub-client --json channels list
+axonhub-client --json models list
+axonhub-client --json api-keys list --status enabled
+axonhub-client --json diagnostics channel-health --limit 10
+```
+
+创建或修改资源时，命令默认只预览将要执行的操作，不会直接修改 AxonHub。确认无误后，再追加 `--confirm` 执行真实变更：
+
+```powershell
+axonhub-client channels create `
+  --type openai `
+  --name "openai-main" `
+  --upstream-base-url "https://api.openai.com/v1" `
+  --api-key "sk-..." `
+  --tag prod
+
+axonhub-client channels create `
+  --type openai `
+  --name "openai-main" `
+  --upstream-base-url "https://api.openai.com/v1" `
+  --api-key "sk-..." `
+  --tag prod `
+  --confirm
+```
+
+更多命令、参数和输入文件格式见 [使用说明](docs/使用说明.md)。
+
+## Python Client
+
+也可以在 Python 代码中直接使用 client：
+
+```python
+from axonhub_client import AxonHubClient
+
+client = AxonHubClient.from_config(
+    "https://your-axonhub.example.com",
+    admin_token="your-admin-token",
+)
+
+channels = client.channels.list(first=20)
+```
+
+## 安全说明
+
+- 创建、修改、删除等操作默认只预览，不会直接修改 AxonHub；传入 `--confirm` 后才会执行。
+- 命令输出会自动遮盖常见敏感信息，例如 API key、token 和密码。
+- 查询渠道时不会读取渠道中保存的上游密钥配置。
+- 查询已禁用的渠道密钥时不会读取密钥明文。
+- 查看 AxonHub API Key / Profile 信息时不会读取 API key 明文。
+- `auth login` 不保存密码，默认也不会打印登录 token。
+- 测试渠道和测试渠道内 API key 会真实请求上游服务，可能消耗额度，因此也需要显式确认。
+
+## 许可证
+
+本项目使用 Apache License 2.0，详见 [LICENSE](LICENSE)。
+

axonhub_client-0.1.0/README.md

@@ -0,0 +1,126 @@
+# AxonHubClient
+
+`AxonHubClient` 是用于管理 AxonHub 实例的 Python client 和命令行工具。它面向 AxonHub Admin API，通过 Admin Token 访问 `/admin/graphql`，用于盘点和管理渠道、模型、API Key / Profile、用量、请求日志、Trace 和诊断信息。
+
+## 适用场景
+
+- 查看 AxonHub 实例中的渠道、模型、用量和请求状态。
+- 批量导入、创建、更新、启停或排序渠道。
+- 管理模型和模型关联规则。
+- 检查渠道健康状态、请求日志、用量日志和 Trace。
+- 在自动化脚本或 Agent 工作流中复用同一套 AxonHub 管理操作。
+
+本项目不负责获取上游 API 资源。调用方应确保传入的 endpoint、API key 和模型信息已经获得授权。
+
+## 文档
+
+- [使用说明](docs/使用说明.md)：完整 CLI 命令、参数、确认规则和示例。
+- [示例输入](docs/examples/)：渠道、模型、排序和 endpoint 等 JSON 输入样例。
+
+## 安装
+
+推荐使用 `uv` 作为独立命令行工具安装：
+
+```bash
+uv tool install axonhub-client
+axonhub-client --help
+```
+
+升级和卸载：
+
+```bash
+uv tool upgrade axonhub-client
+uv tool uninstall axonhub-client
+```
+
+Windows 用户也可以从 GitHub Release 下载 `axonhub-client-windows-x64-vX.Y.Z.zip`，解压后直接运行：
+
+```powershell
+.\axonhub-client.exe --help
+```
+
+从源码目录开发时：
+
+```bash
+uv sync --extra dev
+uv run axonhub-client --help
+```
+
+命名约定：安装包、CLI 命令和发布产物使用 `axonhub-client`；Python import 包名使用 `axonhub_client`。
+
+## 快速开始
+
+首次使用先登录 AxonHub 管理后台。登录成功后，CLI 会把默认 session 保存到当前用户配置目录；session 文件保存实例地址、token、用户摘要和保存时间，不保存密码。
+
+```powershell
+axonhub-client auth login --url https://your-axonhub.example.com --username admin@example.com
+```
+
+上面的命令会继续提示输入密码，密码输入不会回显。需要非交互登录时，可以显式传入 `--password`：
+
+```powershell
+axonhub-client auth login --url https://your-axonhub.example.com --username admin@example.com --password "your-password"
+```
+
+`auth login` 也可以不传参数，按提示交互式输入实例地址、用户名和密码。
+
+常用盘点命令：
+
+```powershell
+axonhub-client --json inventory summary
+axonhub-client --json channels list
+axonhub-client --json models list
+axonhub-client --json api-keys list --status enabled
+axonhub-client --json diagnostics channel-health --limit 10
+```
+
+创建或修改资源时，命令默认只预览将要执行的操作，不会直接修改 AxonHub。确认无误后，再追加 `--confirm` 执行真实变更：
+
+```powershell
+axonhub-client channels create `
+  --type openai `
+  --name "openai-main" `
+  --upstream-base-url "https://api.openai.com/v1" `
+  --api-key "sk-..." `
+  --tag prod
+
+axonhub-client channels create `
+  --type openai `
+  --name "openai-main" `
+  --upstream-base-url "https://api.openai.com/v1" `
+  --api-key "sk-..." `
+  --tag prod `
+  --confirm
+```
+
+更多命令、参数和输入文件格式见 [使用说明](docs/使用说明.md)。
+
+## Python Client
+
+也可以在 Python 代码中直接使用 client：
+
+```python
+from axonhub_client import AxonHubClient
+
+client = AxonHubClient.from_config(
+    "https://your-axonhub.example.com",
+    admin_token="your-admin-token",
+)
+
+channels = client.channels.list(first=20)
+```
+
+## 安全说明
+
+- 创建、修改、删除等操作默认只预览，不会直接修改 AxonHub；传入 `--confirm` 后才会执行。
+- 命令输出会自动遮盖常见敏感信息，例如 API key、token 和密码。
+- 查询渠道时不会读取渠道中保存的上游密钥配置。
+- 查询已禁用的渠道密钥时不会读取密钥明文。
+- 查看 AxonHub API Key / Profile 信息时不会读取 API key 明文。
+- `auth login` 不保存密码，默认也不会打印登录 token。
+- 测试渠道和测试渠道内 API key 会真实请求上游服务，可能消耗额度，因此也需要显式确认。
+
+## 许可证
+
+本项目使用 Apache License 2.0，详见 [LICENSE](LICENSE)。
+

axonhub_client-0.1.0/axonhub_client/__init__.py

@@ -0,0 +1,13 @@
+"""AxonHub Admin GraphQL client."""
+
+from .client import AxonHubClient
+from .exceptions import AxonHubClientError, GraphQLError, HTTPError
+from .transport import GraphQLTransport
+
+__all__ = [
+    "AxonHubClient",
+    "AxonHubClientError",
+    "GraphQLError",
+    "GraphQLTransport",
+    "HTTPError",
+]

axonhub_client-0.1.0/axonhub_client/__main__.py

@@ -0,0 +1,4 @@
+from axonhub_client.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())