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 파일 설정

API 키와 기타 환경별 변수를 저장할 프로젝트 루트에 .env 파일을 만듭니다.

# .env
API_KEY=your_api_key_here

중요: 이 .env 파일은 저장소에 커밋되어서는 안 됩니다. 이를 보장하기 위해 .gitignore를 구성하겠습니다.

3. .gitignore에 .env 추가

.env가 Git에 푸시되지 않도록 .gitignore 파일에 다음 줄을 추가하세요.

# .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가지 팁