Metadata-Version: 2.4
Name: robodock-cli
Version: 0.1.4
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.10
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.10
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文件生成的，不要修改里面的文件，每次生成都会被覆盖

## 上传pypi
```
pip install -e ".[dev]"

python -m build

python -m twine upload dist/*
```
