在 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 個技巧