파이썬 프로젝트 종속성 관리하기 requirements.txt

📦 프로젝트 종속성 관리: requirements.txt

requirements.txt는 Python 프로젝트에서 사용하는 패키지와 해당 버전을 기록한 텍스트 파일로, 프로젝트 종속성을 관리하는 데 사용됩니다. 이를 통해 팀원들이나 다른 사용자들이 동일한 환경에서 작업할 수 있도록 보장합니다.

✅ requirements.txt의 목적

• 프로젝트 환경 재현: 동일한 버전의 패키지를 설치하여 개발 환경을 재현 가능.
• 종속성 관리: 프로젝트에서 사용되는 패키지를 명확히 정의하여, 불필요한 패키지를 줄이고 버전 충돌 방지.
• 협업 용이성: 다른 팀원이 파일을 기반으로 동일한 패키지 환경을 쉽게 설정.

📋 requirements.txt 파일 작성하기

1. 현재 환경에서 사용 중인 패키지 저장

pip freeze > requirements.txt

• pip freeze는 현재 Python 환경에 설치된 모든 패키지를 나열합니다.
• >를 사용하여 출력을 requirements.txt 파일에 저장합니다.

예시: 생성된 requirements.txt

numpy==1.21.2
pandas>=1.3.0
requests==2.26.0
Flask==2.1.1

• numpy==1.21.2: numpy의 1.21.2 버전 설치.
• pandas>=1.3.0: pandas의 1.3.0 이상의 버전 설치.
• requests: 최신 버전 설치.

2. 수동으로 종속성 추가

• 특정 패키지와 버전을 직접 추가할 수도 있습니다.
• 예:

django==4.1.1
djangorestframework==3.13.1

🚀 requirements.txt로 패키지 설치하기

다른 사용자나 팀원이 프로젝트 환경을 설정할 때, requirements.txt를 기반으로 모든 패키지를 설치할 수 있습니다.

1. 패키지 설치 명령

pip install -r requirements.txt

2. 가상 환경에서 설치 (권장)

• 프로젝트마다 독립된 환경을 유지하기 위해 가상 환경 사용이 권장됩니다:

python -m venv venv
source venv/bin/activate      # macOS/Linux
venv\Scripts\activate         # Windows
pip install -r requirements.txt

3. 업그레이드 옵션 사용

• 패키지를 최신 버전으로 업그레이드하면서 설치하려면:

pip install --upgrade -r requirements.txt

🌟 requirements.txt 관리 팁

1. 최신 상태 유지

• 새로운 패키지를 설치하거나 업그레이드한 경우, 파일을 업데이트합니다:

pip freeze > requirements.txt

2. 종속성 확인

• 프로젝트에 불필요한 패키지가 포함되지 않도록 주기적으로 점검하세요.

3. 의존성 분리

• 개발 종속성(예: pytest, black)과 프로덕션 종속성(예: Flask, Django)을 나누기 위해 추가 파일 사용:
  • requirements-dev.txt (개발 환경용)
  • requirements.txt (프로덕션용)

🎯 요약

• requirements.txt는 Python 프로젝트의 종속성을 관리하고 협업을 위한 표준 환경을 제공합니다.
• pip freeze 명령으로 현재 환경에서 사용한 패키지를 저장하고, 이를 통해 다른 팀원도 동일한 환경을 설정할 수 있습니다.
• 가상 환경과 함께 사용하면 더욱 안전하고 깔끔한 프로젝트 관리가 가능합니다.