在 Python 项目中正确管理 API 密钥和环境变量的指南

？介绍

在 Python 中使用 API 时，您经常需要使用 API 密钥或其他敏感凭据。 安全地管理这些密钥以避免泄露敏感信息或意外地将它们提交到您的 Git 存储库至关重要。

如需完整演示，请查看我的 GitHub 存储库 Secure-API-Key-Handling，它具有一个 Streamlit 聊天应用程序，可在与 Gemini Generative AI 模型交互时使用 .env 文件和 python-dotenv 包安全地管理 API 密钥.

？入门

按照以下步骤设置您的项目以进行安全 API 密钥处理：

1.安装依赖项

您需要 python-dotenv 包从 .env 文件加载环境变量。

pip install python-dotenv

2. 设置 .env 文件

在项目根目录中创建一个 .env 文件，您将在其中存储 API 密钥和其他特定于环境的变量：

# .env
API_KEY=your_api_key_here

重要： 这个 .env 文件永远不应该提交到您的存储库。我们将配置 .gitignore 以确保这一点。

3. 将.env添加到.gitignore

将以下行添加到 .gitignore 文件中，以确保 .env 不会被推送到 Git：

# .gitignore
.env

5. 提供 .env.example 文件

对于处理您项目的其他开发人员，请包含 .env.example 文件作为模板：

# .env.example
API_KEY=your_api_key_here

该文件不会包含敏感数据，但它给出了运行项目所需的变量的示例。其他开发人员可以将此文件复制到 .env 并添加他们自己的凭据。

cp .env.example .env

？要避免的常见错误

• 硬编码 API 密钥：切勿直接在 Python 代码中硬编码敏感信息。

# BAD EXAMPLE: Never do this
api_key = "hardcoded_api_key"

• 提交 .env 文件 ：确保 .env 始终包含在 .gitignore 中，以避免意外将其推入版本控制。

• 推送虚拟环境：始终从 Git 中排除虚拟环境（如 venv）：
  

# .gitignore
venv/

？资源：

• 安全 API 密钥处理 GitHub 存储库
• 安全使用 API 密钥的 8 个技巧