@@ -28,7 +28,9 @@ This project is generously sponsored by ZMTO. Visit their website: [https://zmto
2828
2929## 系统要求
3030
31- * ** Python** : >=3.9, <4.0 (由 Poetry 管理)
31+ * ** Python** : >=3.9, <4.0 (推荐 3.10+ 以获得最佳性能)
32+ * ** 依赖管理** : [ Poetry] ( https://python-poetry.org/ ) (现代化Python依赖管理工具)
33+ * ** 类型检查** : [ Pyright] ( https://github.com/microsoft/pyright ) (可选,用于开发时类型检查)
3234* ** 操作系统** : Windows, macOS, Linux (完全跨平台支持)
3335* ** 内存** : 建议 2GB+ 可用内存
3436* ** 网络** : 稳定的互联网连接访问 Google AI Studio
@@ -47,6 +49,7 @@ This project is generously sponsored by ZMTO. Visit their website: [https://zmto
4749* ** 灵活认证系统** : 支持可选的API密钥认证,完全兼容OpenAI标准的Bearer token格式
4850* ** 模块化架构** : 采用清晰的模块化设计,便于维护和扩展
4951* ** 统一配置管理** : 基于 ` .env ` 文件的统一配置方式,支持环境变量覆盖
52+ * ** 现代化开发工具** : 集成 Poetry 依赖管理和 Pyright 类型检查,提供优秀的开发体验
5053
5154## 系统架构
5255
@@ -158,10 +161,32 @@ python launch_camoufox.py --headless
158161
159162### 快速开始
160163
161- 本项目现在使用 [ Poetry] ( https://python-poetry.org/ ) 进行依赖管理。
164+ 本项目采用现代化的 Python 开发工具链,使用 [ Poetry] ( https://python-poetry.org/ ) 进行依赖管理, [ Pyright ] ( https://github.com/microsoft/pyright ) 进行类型检查 。
162165
163- 1 . ** 安装 Poetry** :
164- 如果您尚未安装 Poetry,请参照其官方文档进行安装:[ Poetry Installation] ( https://python-poetry.org/docs/#installation ) 。
166+ #### 🚀 一键安装脚本 (推荐)
167+
168+ ``` bash
169+ # macOS/Linux 用户
170+ curl -sSL https://raw.githubusercontent.com/CJackHwang/AIstudioProxyAPI/main/scripts/install.sh | bash
171+
172+ # Windows 用户 (PowerShell)
173+ iwr -useb https://raw.githubusercontent.com/CJackHwang/AIstudioProxyAPI/main/scripts/install.ps1 | iex
174+ ```
175+
176+ #### 📋 手动安装步骤
177+
178+ 1 . ** 安装 Poetry** (如果尚未安装):
179+ ``` bash
180+ # macOS/Linux
181+ curl -sSL https://install.python-poetry.org | python3 -
182+
183+ # Windows (PowerShell)
184+ (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
185+
186+ # 或使用包管理器
187+ # macOS: brew install poetry
188+ # Ubuntu/Debian: apt install python3-poetry
189+ ```
165190
1661912. ** 克隆项目** :
167192 ` ` ` bash
@@ -170,38 +195,68 @@ python launch_camoufox.py --headless
170195 ` ` `
171196
1721973. ** 安装依赖** :
173- 使用 Poetry 安装项目依赖。这会自动创建一个虚拟环境(如果当前没有激活的虚拟环境)。
198+ Poetry 会自动创建虚拟环境并安装所有依赖:
174199 ` ` ` bash
175200 poetry install
176201 ` ` `
177202
178- 4. ** 激活虚拟环境 (可选但推荐)** :
179- 要激活 Poetry 创建的虚拟环境,请运行:
203+ 4. ** 激活虚拟环境** :
180204 ` ` ` bash
205+ # 方式1: 激活 shell (推荐日常开发)
181206 poetry shell
207+
208+ # 方式2: 直接运行命令 (推荐自动化脚本)
209+ poetry run python gui_launcher.py
182210 ` ` `
183- 之后,您可以直接运行 Python 脚本 (例如 ` python gui_launcher.py` )。
184- 或者,如果您不想激活 shell,可以在每个命令前加上 ` poetry run` (例如 ` poetry run python gui_launcher.py` )。
185211
186- 5. ** 配置** : 参见 [环境变量配置指南](docs/environment-configuration.md) - ** 推荐先配置**
212+ # ### 🔧 后续配置步骤
213+
214+ 5. ** 环境配置** : 参见 [环境变量配置指南](docs/environment-configuration.md) - ** 推荐先配置**
1872156. ** 首次认证** : 参见 [认证设置指南](docs/authentication-setup.md)
188- 7. ** 日常运行** : 参见 [日常运行指南](docs/daily-usage.md) (请使用 ` poetry run python launch_camoufox.py ` 或在 ` poetry shell ` 中运行 ` python launch_camoufox.py ` )
216+ 7. ** 日常运行** : 参见 [日常运行指南](docs/daily-usage.md)
1892178. ** API使用** : 参见 [API使用指南](docs/api-usage.md)
1902189. ** Web界面** : 参见 [Web UI使用指南](docs/webui-guide.md)
191219
192- # ## 详细文档
220+ # ### 🛠️ 开发者选项
221+
222+ 如果您是开发者,还可以:
223+
224+ ` ` ` bash
225+ # 安装开发依赖 (包含类型检查、测试工具等)
226+ poetry install --with dev
227+
228+ # 启用类型检查 (需要安装 pyright)
229+ npm install -g pyright
230+ pyright
193231
232+ # 查看项目依赖树
233+ poetry show --tree
234+
235+ # 更新依赖
236+ poetry update
237+ ` ` `
238+
239+ # ## 📚 详细文档
240+
241+ # ### 🚀 快速上手
194242- [安装指南](docs/installation-guide.md) - 详细的安装步骤和环境配置
195243- [环境变量配置指南](docs/environment-configuration.md) - ** .env 文件配置管理** ⭐
196244- [认证设置指南](docs/authentication-setup.md) - 首次运行与认证文件设置
197245- [日常运行指南](docs/daily-usage.md) - 日常使用和配置选项
246+
247+ # ### 🔧 功能使用
198248- [API使用指南](docs/api-usage.md) - API端点和客户端配置
199249- [Web UI使用指南](docs/webui-guide.md) - Web界面功能说明
200- - [故障排除指南](docs/troubleshooting.md) - 常见问题解决方案
201- - [高级配置指南](docs/advanced-configuration.md) - 高级功能和配置选项
202250- [脚本注入指南](docs/script_injection_guide.md) - 油猴脚本动态挂载功能使用指南 (v3.0) 🆕
251+
252+ # ### ⚙️ 高级配置
253+ - [高级配置指南](docs/advanced-configuration.md) - 高级功能和配置选项
203254- [日志控制指南](docs/logging-control.md) - 日志系统配置和调试
204- - [依赖版本说明](docs/dependency-versions.md) - Python版本要求和依赖兼容性详解
255+ - [故障排除指南](docs/troubleshooting.md) - 常见问题解决方案
256+
257+ # ### 🛠️ 开发相关
258+ - [开发者指南](docs/development-guide.md) - Poetry、Pyright 和开发工作流程 🆕
259+ - [依赖版本说明](docs/dependency-versions.md) - Poetry 依赖管理和版本控制详解
205260
206261# # 客户端配置示例
207262
@@ -217,13 +272,13 @@ python launch_camoufox.py --headless
217272
218273---
219274
220- # # Docker 部署
275+ # # 🐳 Docker 部署
221276
222- 本项目支持通过 Docker 进行部署,** 现在完全支持 ` .env` 配置文件** !
277+ 本项目支持通过 Docker 进行部署,使用 ** Poetry ** 进行依赖管理, ** 完全支持 ` .env` 配置文件** !
223278
224279> 📁 ** 注意** : 所有 Docker 相关文件已移至 ` docker/` 目录,保持项目根目录整洁。
225280
226- # ## 快速 Docker 部署
281+ # ## 🚀 快速 Docker 部署
227282
228283` ` ` bash
229284# 1. 准备配置文件
@@ -234,20 +289,26 @@ nano .env # 编辑配置
234289# 2. 使用 Docker Compose 启动
235290docker compose up -d
236291
237- # 3. 版本更新 (在 docker 目录下)
292+ # 3. 查看日志
293+ docker compose logs -f
294+
295+ # 4. 版本更新 (在 docker 目录下)
238296bash update.sh
239297` ` `
240298
241- # ## 详细文档
299+ # ## 📚 详细文档
242300
243- - [Docker 部署指南 (docker/README-Docker.md)](docker/README-Docker.md) - 包含完整的 ` .env` 配置说明
301+ - [Docker 部署指南 (docker/README-Docker.md)](docker/README-Docker.md) - 包含完整的 Poetry + ` .env` 配置说明
244302- [Docker 快速指南 (docker/README.md)](docker/README.md) - 快速开始指南
245303
246- # ## 重要说明
304+ # ## ✨ Docker 特性
247305
306+ - ✅ ** Poetry 依赖管理** : 使用现代化的 Python 依赖管理工具
307+ - ✅ ** 多阶段构建** : 优化镜像大小和构建速度
248308- ✅ ** 配置统一** : 使用 ` .env` 文件管理所有配置
249309- ✅ ** 版本更新** : ` bash update.sh` 即可完成更新
250310- ✅ ** 目录整洁** : Docker 文件已移至 ` docker/` 目录
311+ - ✅ ** 跨平台支持** : 支持 x86_64 和 ARM64 架构
251312- ⚠️ ** 认证文件** : 首次运行需要在主机上获取认证文件,然后挂载到容器中
252313
253314---
0 commit comments