Metadata-Version: 2.4
Name: robodock-cli
Version: 0.1.6.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.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.28.0,>=0.20.0
Requires-Dist: rich<16.0.0,>=13.0.0
Requires-Dist: httpx<0.29.0,>=0.23.1
Requires-Dist: attrs<27.0.0,>=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
```

开发调试时先以 editable 模式安装，然后可以直接运行命令或模块：

```bash
pip install -e ".[dev]"
robodock-cli auth info
# 或者
python -m robodock_cli auth info
```

## 整体架构

项目采用 `src` 单包布局，安装后只会向 `site-packages` 添加
`robodock_cli` 包和对应的 `.dist-info` 元数据：

```text
src/robodock_cli/
├── cli/          # Typer 命令行
├── client/       # API 的上层封装
├── utils/        # 下载等通用工具
├── _generated/   # 由 openapi.json 生成的底层 client
├── config.py
├── exceptions.py
└── __main__.py
```

`_generated` 目录由 OpenAPI 生成，不要手动修改其中的文件。

## 开发依赖

```bash
pip install -r requirements.txt
```

## 生成后端 client

```bash
openapi-python-client generate --path ./openapi.json --overwrite
rm -rf ./src/robodock_cli/_generated
cp -r ./fast-api-client/fast_api_client ./src/robodock_cli/_generated
```

生成完成后，应保持业务代码只通过 `robodock_cli._generated`
引用底层 client。

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

python -m build

python -m twine upload dist/*
```
