问题描述
作为新用户,按照 README.md 和 SKILL.md 中的说明尝试安装和使用本项目时,遇到多处文档缺失导致无法正常完成配置。
具体问题
1. 账号注册流程未说明
- README 和 SKILL.md 均提到需要配置
PANDA_DATA_USERNAME 和 PANDA_DATA_PASSWORD,但没有说明如何注册账号
- 用户不知道应该去哪个平台注册(官网地址是什么?)
- 不清楚用户名格式(手机号?邮箱?自定义用户名?)
2. panda_data 包的安装方式不明确
pyproject.toml 中依赖了 panda_data,PyPI 上存在 panda-data 0.0.1 版本
- 但 SKILL.md 第 34 行写到:
panda_data 包需通过本地 whl 单独安装
- 两处说法矛盾,用户困惑:到底是用
pip install panda-data 还是需要另外获取 .whl 文件?
- 如果需要
.whl,从哪里下载?
3. 认证错误信息不够友好
- 使用已注册的凭证调用
init_token() 时,如果凭证信息有误,服务端返回的错误码(如 200006: 用户未注册)缺乏引导性
- 建议在错误提示中附加注册链接或帮助文档入口
4. .env 模板缺乏注释说明
当前 .env 文件内容仅有:
PANDA_DATA_USERNAME=""
PANDA_DATA_PASSWORD=""
建议补充注释,例如:
# PandaAI 账号凭证,注册地址:https://xxx.xxx
# 用户名格式:手机号/邮箱
PANDA_DATA_USERNAME=""
PANDA_DATA_PASSWORD=""
建议改进
- 在 README.md 中增加 快速开始 章节,包含:注册链接 → 获取凭证 → 安装依赖 → 首次调用 的完整流程
- 明确
panda_data 包的安装来源(PyPI 还是本地 whl),并统一 SKILL.md 与 pyproject.toml 的说法
- 在
.env 模板中添加注释说明
- 在认证失败时提供更具引导性的错误提示
环境信息
- OS: macOS (ARM64)
- Python: 3.12.13
- panda_data: 0.0.1 (PyPI)
- panda-data-tools: 0.0.1
问题描述
作为新用户,按照 README.md 和 SKILL.md 中的说明尝试安装和使用本项目时,遇到多处文档缺失导致无法正常完成配置。
具体问题
1. 账号注册流程未说明
PANDA_DATA_USERNAME和PANDA_DATA_PASSWORD,但没有说明如何注册账号2.
panda_data包的安装方式不明确pyproject.toml中依赖了panda_data,PyPI 上存在panda-data0.0.1 版本pip install panda-data还是需要另外获取.whl文件?.whl,从哪里下载?3. 认证错误信息不够友好
init_token()时,如果凭证信息有误,服务端返回的错误码(如200006: 用户未注册)缺乏引导性4.
.env模板缺乏注释说明当前
.env文件内容仅有:建议补充注释,例如:
建议改进
panda_data包的安装来源(PyPI 还是本地 whl),并统一 SKILL.md 与 pyproject.toml 的说法.env模板中添加注释说明环境信息