Metadata-Version: 2.4
Name: yongle-worker
Version: 0.1.2
Summary: Yongle local data collection CLI
Author: Yongle Platform Team
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: httpx<1.0,>=0.27.0
Requires-Dist: prompt-toolkit<4.0,>=3.0.43
Requires-Dist: pydantic<3.0,>=2.7.0
Requires-Dist: rich<15.0,>=13.7.1
Requires-Dist: python-dotenv<2.0,>=1.0.1
Requires-Dist: cryptography<47.0,>=46.0.7
Provides-Extra: browser
Requires-Dist: browser-cookie3<1.0,>=0.20.1; extra == "browser"
Provides-Extra: dev
Requires-Dist: build>=1.2.1; extra == "dev"
Requires-Dist: twine>=5.1.1; extra == "dev"

﻿# yongle-worker

`yongle-worker` 是永乐数据平台的本地采集 CLI。采集任务在你的电脑上执行，平台账号用于登录、余额校验和任务结算。

## 安装

```bash
pip install yongle-worker
```

建议使用 Python 3.10 或更高版本。

## 快速开始

启动交互模式：

```bash
yongle-worker
```

登录账号：

```text
/login YOUR_API_KEY
```

公网服务地址已内置，正常使用不需要额外配置。

查看可用模型：

```bash
yongle-worker run --list-models
```

运行携程采集：

```bash
yongle-worker run --model 携程 --city 杭州 --pages 3 --items 20 --comments 5
```

运行 BOSS 采集：

```bash
yongle-worker auth boss import-browser --browser auto
yongle-worker run --model Boss直聘 --keyword 爬虫工程师 --city 上海 --pages 2
```

## 常用命令

```bash
yongle-worker
yongle-worker run --list-models
yongle-worker run --interactive
yongle-worker doctor
yongle-worker doctor --provider boss --skip-control
yongle-worker auth boss import-browser --browser auto
```

说明：

- `run`：正式任务入口，执行前会展示任务预览和预计点数。
- `run --interactive`：按步骤填写任务参数。
- `doctor`：检查本机运行环境和账号状态。
- `auth boss import-browser`：从本机浏览器导入 BOSS 登录态，用于本机采集。

## 登录与本地数据

- CLI 默认连接永乐数据公网服务，不需要额外配置服务地址。
- API Key 只用于当前设备登录和任务结算，请不要发给他人。
- 登录态默认保存在本机，并尽量使用本机加密能力保护。
- BOSS Cookie 只用于本机采集，不需要手动粘贴到平台页面。
- 如不想保存本机登录态，可设置 `YONGLE_PERSIST_LOGIN_SESSION=0`。

## 常见问题

### 401 或 API Key 无效

确认 API Key 是否复制完整，并重新执行：

```text
/login YOUR_API_KEY
```

### 余额不足

减少任务页数、条数或评论数，或先完成充值后重试。

### BOSS 任务提示未登录

先在本机浏览器登录 BOSS，再执行：

```bash
yongle-worker auth boss import-browser --browser auto
```

### 网络连接失败

执行：

```bash
yongle-worker doctor
```

如果只是临时网络问题，稍后重试即可。

## 隐私边界

- 采集过程在用户本机执行。
- 请只在你有合法授权的场景下使用本工具。
- 不要在公开聊天、截图或工单中暴露 API Key、浏览器 Cookie、验证码、支付订单号等敏感信息。
