说明/指示
根据你是VSCode用户,或者是否安装了Docker,有几种不同的开始方式。首先,将仓库克隆到本地。
1. VSCode + Docker:在开发容器中快速入门
- 安装 Docker 和 VSCode 的开发容器扩展。
- 更新环境变量的值
.devcontainer/devcontainer.json. - 在VSCode中,打开命令面板(Ctrl+Shift+P)并选择 开发容器:在容器中重新打开如果它抱怨工作区有问题,请选择
Open Workspace然后打开在/app - 一旦容器准备就绪,就用以下命令启动助手:
python3 src/interactive来自集成终端。
2. 仅Docker:使用Docker Compose运行
- 填写所需的默认值在
environment(某事物的)部分docker-compose.yml(保留前面的连字符:-) - 构建镜像:
docker compose build- 运行应用程序:
docker compose run app注:变量优先级: Docker Compose 按以下顺序(从高到低)解析环境变量。如果你已经在 shell 中定义了某个变量,这一点非常重要:
- (如果使用VSCode开发容器):其中的值
containerEnvof 的中文翻译是“的”devcontainer.json - 在您的shell中设置的环境变量(例如。,
export OPENAI_API_KEY=...) - 来自……的值
.env项目根目录下的文件 - 在(某处)指定的默认值
docker-compose.yml(例如。,gpt-4o-miniforOPENAI_MODEL)。 即使在你的shell中有变量,你也可以完全覆盖这些值为任意你选择的值,只需简单地设置值而无需使用特定的格式${shellVar:-default}
小贴士如果你在处理环境变量值时遇到问题,尝试从容器中读取它们,使用 docker compose run app /bin/bash -c 'env'。
3. Python 3.9+:使用 Python + venv 本地运行
- 确保已安装 Python 3.9 或更高版本。
- 做一个当地人(或:融入当地)
.env通过命令cp .env.example .env - 填写
.env在项目根目录下的文件中填写您的API凭据:
OPENAI_API_KEY=your_openai_api_key
OPENAI_MODEL=gpt-4o-mini
XWEATHER_CLIENT_ID=your_xweather_client_id
XWEATHER_CLIENT_SECRET=your_xweather_client_secret- 创建并激活虚拟环境:
python3 -m venv .venv
source .venv/bin/activate- 安装依赖项:
pip install -r requirements.txt- 启动助手:
python3 src/interactive- 完成后,使用以下命令停用环境:
deactivate.
