LLM-Engineers-Handbook

环境要求

• Python 3.11（项目要求，可用全局 Python 或 pyenv）
• Poetry 1.8.3 或更高版本（用于依赖管理）
• Git（用于获取仓库代码）
• OpenAI API Key 与 AWS 账号（云端部署时需要，按量付费）

安装与启动步骤

1. 1获取项目代码

   把仓库克隆到本地并进入项目根目录，.env 必须放在仓库根目录。README 未直接给出克隆命令，此处使用项目 GitHub 地址。

   git clone https://github.com/PacktPublishing/LLM-Engineers-Handbook.git
   cd LLM-Engineers-Handbook

   复制

2. 2确认 Python 版本

   项目要求 Python 3.11，先确认本机版本，输出应为 Python 3.11.x 才能继续。

   python --version

   复制

3. 3确认 Poetry 版本

   项目用 Poetry 管理依赖，版本需为 1.8.3 或更高，过低请先升级 Poetry。

   poetry --version

   复制

4. 4创建环境并装依赖

   让 Poetry 使用 3.11，安装依赖（排除 AWS 相关包），并安装 pre-commit 代码检查钩子。三条命令按顺序执行。

   poetry env use 3.11
   poetry install --without aws
   poetry run pre-commit install

   复制

5. 5生成 .env 文件

   从示例文件复制出 .env，必须放在仓库根目录，该文件不会提交到 GitHub，可安全存放密钥。

   cp .env.example .env

   复制

6. 6填写凭据并运行

   按 README 说明填好 .env 中所有必填变量；本地开发时 Mongo、Qdrant 等默认值可直接用，随后按 README 步骤运行完整流程。

如何确认成功

poetry install 无报错、pre-commit 钩子安装成功，且 .env 中必填项填完后，即可按 README 的 Run project 步骤跑通端到端流程。

常见问题

注意事项

• .env 存放敏感凭据，不要提交到 GitHub 或分享给他人。
• README 未列出 .env 中具体变量名，请以仓库内 .env.example 和手册正文为准逐项填写。
• 云端部署需额外配置 Mongo、Qdrant 与 AWS；纯本地开发使用默认值即可。
• 推荐按手册章节顺序阅读，先跑通本地 RAG 流程再上云，避免一上来就产生 AWS 费用。