Python プロジェクトで API キーと環境変数を適切に管理するためのガイド

?導入

Python で API を操作する場合、多くの場合、API キーやその他の機密性の高い認証情報を使用する必要があります。機密情報が漏洩したり、Git リポジトリに誤ってコミットされたりしないように、これらのキーを安全に管理することが重要です。

完全なデモについては、私の GitHub リポジトリ Secure-API-Key-Handling をご覧ください。これには、Gemini Generative AI モデルと対話しながら、.env ファイルと python-dotenv パッケージを使用して API キーを安全に管理する Streamlit チャット アプリが搭載されています。 .

?はじめる

次の手順に従って、安全な API キーを処理できるようにプロジェクトを設定します:

1. 依存関係をインストールする

.env ファイルから環境変数を読み込むには、python-dotenv パッケージが必要です。

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/

?リソース：

• GitHub リポジトリの安全な API キー処理
• API キーを安全に使用するための 8 つのヒント