robodock-cli 0.1.0__tar.gz

robodock_cli-0.1.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: robodock-cli
+Version: 0.1.0
+Summary: Robodock 平台命令行 & SDK 工具
+Author-email: KirigiriSuzumiya <boyifan1@126.com>
+Project-URL: Homepage, https://github.com/FII-AILab/robodock-cli
+Project-URL: Repository, https://github.com/FII-AILab/robodock-cli
+Project-URL: Issues, https://github.com/FII-AILab/robodock-cli/issues
+Keywords: robodock,cli,sdk,rl,post-train
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: typer>=0.9
+Requires-Dist: rich
+Requires-Dist: httpx<0.29.0,>=0.23.1
+Requires-Dist: attrs>=22.2.0
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: openapi-python-client; extra == "dev"
+
+# robodock-cli robodock平台命令行&sdk工具
+
+## 安装
+
+### 方式一：本地源码安装（推荐）
+
+```bash
+cd robodock-cli
+pip install .
+```
+
+### 方式二：构建 wheel 后安装
+
+```bash
+cd robodock-cli
+pip install build
+python -m build
+pip install dist/robodock_cli-*.whl
+```
+
+## Quick Start
+
+```bash
+# 登录
+robodock-cli auth login
+
+# 查看登录信息
+robodock-cli auth info
+
+# 退出登录
+robodock-cli auth logout
+
+# 下载平台模型
+robodock-cli task download_checkpoint [run_uuid] [checkpoint_prefix]
+
+# 查看全部命令
+robodock-cli --help
+```
+
+开发调试时也可以继续使用 `python main.py`，例如 `python main.py auth info`。
+
+## 整体架构
+- app
+    - typer命令行工具
+- fast_api_client
+    - 由openapi.json生成的client代码（不要手动修改里面的文件）
+- sdk
+    - client以及工具封装
+- config.py
+    - 全局配置（服务地址、登录态文件路径等）
+
+> 注意：`config.py` 会以顶层模块的形式打包进 wheel，若与其他包同名可能冲突。
+
+## 开发依赖
+
+```bash
+pip install -r requirements.txt
+```
+
+## 生成后端client
+```
+openapi-python-client generate --path ./openapi.json --overwrite
+rm -rf ./fast_api_client
+cp -r fast-api-client/fast_api_client/ ./fast_api_client/
+```
+
+注意`fast_api_client`目录是由openapi文件生成的，不要修改里面的文件，每次生成都会被覆盖

robodock_cli-0.1.0/README.md

@@ -0,0 +1,67 @@
+# robodock-cli robodock平台命令行&sdk工具
+
+## 安装
+
+### 方式一：本地源码安装（推荐）
+
+```bash
+cd robodock-cli
+pip install .
+```
+
+### 方式二：构建 wheel 后安装
+
+```bash
+cd robodock-cli
+pip install build
+python -m build
+pip install dist/robodock_cli-*.whl
+```
+
+## Quick Start
+
+```bash
+# 登录
+robodock-cli auth login
+
+# 查看登录信息
+robodock-cli auth info
+
+# 退出登录
+robodock-cli auth logout
+
+# 下载平台模型
+robodock-cli task download_checkpoint [run_uuid] [checkpoint_prefix]
+
+# 查看全部命令
+robodock-cli --help
+```
+
+开发调试时也可以继续使用 `python main.py`，例如 `python main.py auth info`。
+
+## 整体架构
+- app
+    - typer命令行工具
+- fast_api_client
+    - 由openapi.json生成的client代码（不要手动修改里面的文件）
+- sdk
+    - client以及工具封装
+- config.py
+    - 全局配置（服务地址、登录态文件路径等）
+
+> 注意：`config.py` 会以顶层模块的形式打包进 wheel，若与其他包同名可能冲突。
+
+## 开发依赖
+
+```bash
+pip install -r requirements.txt
+```
+
+## 生成后端client
+```
+openapi-python-client generate --path ./openapi.json --overwrite
+rm -rf ./fast_api_client
+cp -r fast-api-client/fast_api_client/ ./fast_api_client/
+```
+
+注意`fast_api_client`目录是由openapi文件生成的，不要修改里面的文件，每次生成都会被覆盖

robodock_cli-0.1.0/app/__init__.py

@@ -0,0 +1 @@
+"""Robodock CLI 命令行入口。"""

robodock_cli-0.1.0/app/app.py

@@ -0,0 +1,14 @@
+"""robodock-cli 命令行入口。"""
+import typer
+
+from app.auth import auth_app
+from app.task_management import task_management_app
+
+app = typer.Typer(help="Robodock 命令行工具", suggest_commands=True)
+app.add_typer(auth_app, name="auth")
+app.add_typer(task_management_app, name="task")
+
+
+def main() -> None:
+    """CLI 入口函数，供 console script 与 ``python -m`` 调用。"""
+    app()

robodock_cli-0.1.0/app/auth.py

@@ -0,0 +1,58 @@
+import typer
+
+from sdk.client.client import RobodockClient
+from sdk.exception import (
+    NotLoggedInError,
+    RobodockError,
+    UserInfoError
+)
+
+auth_app = typer.Typer(help="Robodock登录认证")
+
+@auth_app.command("login")
+def login():
+    """登录 Robodock 平台。"""
+    username = typer.prompt("用户名或邮箱", hide_input=False)
+    password = typer.prompt("密码", hide_input=True)
+
+    client = RobodockClient()
+    try:
+        client.auth.login(username=username, password=password)
+    except RobodockError as e:
+        typer.echo(f"登录失败: {e}", err=True)
+        raise typer.Exit(code=1)
+
+    client.auth.save_state()
+    typer.echo("登录成功")
+    info()  # 显示当前登录状态
+
+
+@auth_app.command("logout")
+def logout():
+    """退出登录并清除本地登录态。"""
+    client = RobodockClient()
+    try:
+        client.auth.logout()
+    except NotLoggedInError:
+        typer.echo("当前未登录", err=False)
+        raise typer.Exit(code=1)
+    except RobodockError as e:
+        typer.echo(f"退出登录失败: {e}", err=True)
+        raise typer.Exit(code=1)
+    finally:
+        client.auth.clear_state()
+    typer.echo("已退出登录")
+
+
+@auth_app.command("info")
+def info():
+    """查看当前登录状态。"""
+    client = RobodockClient()
+    try:
+        user_info = client.auth.info()
+    except NotLoggedInError as e:
+        return typer.echo("当前未登录", err=False)
+    except UserInfoError as e:
+        typer.echo(f"获取当前登录状态失败: {e}", err=True)
+        raise typer.Exit(code=1)
+    typer.echo(f"当前已登录: {user_info.get('username')} ({user_info.get('email')})")

robodock_cli-0.1.0/app/task_management.py

@@ -0,0 +1,97 @@
+import typer
+from pathlib import Path
+from typing import Optional
+
+from rich.progress import (
+    BarColumn,
+    DownloadColumn,
+    Progress,
+    TextColumn,
+    TimeRemainingColumn,
+    TransferSpeedColumn,
+)
+
+from sdk.utils.downloader import download_file
+from sdk.client.client import RobodockClient
+from sdk.exception import (
+    NotLoggedInError,
+    RobodockError,
+    UserInfoError
+)
+
+ONNX_PATH_SUFFIX = "_onnx.tar"
+MODEL_PATH_SUFIX = ".tar"
+
+task_management_app = typer.Typer(help="Robodock训练任务管理")
+
+@task_management_app.command("download_checkpoint")
+def download_checkpoint(
+    run_uuid:str,
+    checkpoint_prefix:str,
+    output_path:str=str(Path.cwd()),
+    overwrite:bool=False,
+):
+    local_path = Path(output_path) / run_uuid / Path(checkpoint_prefix).stem
+    checkpoint_model_path = checkpoint_prefix + MODEL_PATH_SUFIX
+    checkpoint_onnx_path = checkpoint_prefix + ONNX_PATH_SUFFIX
+    client = RobodockClient()
+
+    def get_model_url() -> str:
+        return client.task_management.get_checkpoint_download_url(
+                run_uuid=run_uuid,
+                checkpoint_path=checkpoint_model_path
+            )
+    def get_onnx_url() -> str:
+        return client.task_management.get_checkpoint_download_url(
+                run_uuid=run_uuid,
+                checkpoint_path=checkpoint_onnx_path
+            )
+
+    model_url = get_model_url()
+    typer.echo("已获取模型下载链接")
+    onnx_url = get_onnx_url()
+    typer.echo("已获取onnx模型下载链接")
+    typer.echo(f"开始下载模型文件到{str(local_path)}")
+
+    
+
+    progress = Progress(
+        TextColumn("[bold blue]{task.description}", justify="left"),
+        BarColumn(bar_width=None),
+        "[progress.percentage]{task.percentage:>3.1f}%",
+        "•",
+        DownloadColumn(),
+        "•",
+        TransferSpeedColumn(),
+        "•",
+        TimeRemainingColumn(),
+    )
+
+    with progress:
+        onnx_task = progress.add_task(f"正在下载onnx文件", total=None)
+        download_file(
+            presigned_url=onnx_url,
+            local_path=local_path / Path(checkpoint_onnx_path).name,
+            get_presigned_url=get_model_url,
+            on_progress=lambda downloaded, total: progress.update(
+                onnx_task,
+                completed=downloaded,
+                total=total,
+            ),
+            overwrite=overwrite
+        )
+
+        model_task = progress.add_task(f"正在下载模型文件", total=None)
+        download_file(
+            presigned_url=model_url,
+            local_path=local_path / Path(checkpoint_model_path).name,
+            get_presigned_url=get_model_url,
+            on_progress=lambda downloaded, total: progress.update(
+                model_task,
+                completed=downloaded,
+                total=total,
+            ),
+            overwrite=overwrite
+        )
+
+    typer.echo("模型下载完成")

robodock_cli-0.1.0/config.py

@@ -0,0 +1,9 @@
+from pathlib import Path
+
+ROBODOCK_BASEURL = "http://43.179.183.27"
+
+# 登录态持久化文件：CLI 每次调用是独立进程，登录后把 token 存到本地
+SESSION_FILE = Path.home() / ".robodock-cli" / "session.json"
+
+# 提前多少秒刷新 token，避免请求过程中 token 过期
+REFRESH_AHEAD_SECONDS = 60

robodock_cli-0.1.0/fast_api_client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing FastAPI"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

robodock_cli-0.1.0/fast_api_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

robodock_cli-0.1.0/fast_api_client/api/auth/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

robodock_cli-0.1.0/fast_api_client/api/auth/change_password_api_p_v1_auth_change_password_post.py

@@ -0,0 +1,172 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.change_password_request import ChangePasswordRequest
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: ChangePasswordRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/p/v1/auth/change-password",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = response.json()
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: ChangePasswordRequest,
+) -> Response[Any | HTTPValidationError]:
+    """Change Password
+
+     修改密码
+
+    Args:
+        body (ChangePasswordRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: ChangePasswordRequest,
+) -> Any | HTTPValidationError | None:
+    """Change Password
+
+     修改密码
+
+    Args:
+        body (ChangePasswordRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: ChangePasswordRequest,
+) -> Response[Any | HTTPValidationError]:
+    """Change Password
+
+     修改密码
+
+    Args:
+        body (ChangePasswordRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: ChangePasswordRequest,
+) -> Any | HTTPValidationError | None:
+    """Change Password
+
+     修改密码
+
+    Args:
+        body (ChangePasswordRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

robodock_cli-0.1.0/fast_api_client/api/auth/forgot_password_api_p_v1_auth_forgot_password_post.py

@@ -0,0 +1,172 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.forgot_password_request import ForgotPasswordRequest
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: ForgotPasswordRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/p/v1/auth/forgot-password",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = response.json()
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ForgotPasswordRequest,
+) -> Response[Any | HTTPValidationError]:
+    """Forgot Password
+
+     发送密码重置邮件（Phase 4 完善）
+
+    Args:
+        body (ForgotPasswordRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ForgotPasswordRequest,
+) -> Any | HTTPValidationError | None:
+    """Forgot Password
+
+     发送密码重置邮件（Phase 4 完善）
+
+    Args:
+        body (ForgotPasswordRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ForgotPasswordRequest,
+) -> Response[Any | HTTPValidationError]:
+    """Forgot Password
+
+     发送密码重置邮件（Phase 4 完善）
+
+    Args:
+        body (ForgotPasswordRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ForgotPasswordRequest,
+) -> Any | HTTPValidationError | None:
+    """Forgot Password
+
+     发送密码重置邮件（Phase 4 完善）
+
+    Args:
+        body (ForgotPasswordRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed