pipreqs를 사용하여 requirements.txt 생성하기

pipreqs는 프로젝트에서 실제로 사용된 import를 기반으로 requirements.txt 파일을 자동 생성해주는 유용한 도구입니다. 이를 통해 불필요한 의존성을 제거하고 정확한 requirements.txt 파일을 생성할 수 있습니다.

설치 방법

먼저, pipreqs를 설치합니다:

pip install pipreqs

사용 방법

프로젝트에서 requirements.txt 파일을 생성하려면 다음 단계를 따라주세요:

1. 프로젝트 디렉토리로 이동

cd /path/to/your/project

2. pipreqs 실행

pipreqs .

이 명령어는 현재 디렉토리(및 하위 디렉토리)의 Python 파일을 스캔하여 import된 패키지를 분석하고 필요한 패키지를 확인합니다.

3. 결과 확인

requirements.txt 파일이 프로젝트 디렉토리에 생성됩니다. 내용을 확인하세요:

flask==2.2.3
numpy==1.23.5
pandas==1.5.0

파일에 나열된 버전은 현재 환경과 사용된 패키지에 따라 다릅니다.

4. 의존성 설치

requirements.txt에 나열된 패키지를 설치하려면 다음 명령어를 사용하세요:

pip install -r requirements.txt

5. 추가 옵션

pipreqs는 사용자가 필요에 따라 동작을 커스터마이징할 수 있는 다양한 옵션을 제공합니다:

• 디렉토리 무시:

  pipreqs . --ignore path/to/ignore

• 기존 requirements.txt 덮어쓰기:

  pipreqs . --force

• 출력 파일 경로 지정:

  pipreqs . --savepath /path/to/output/requirements.txt

자주 발생하는 문제

1. 누락된 패키지

pipreqs가 모든 패키지를 감지하지 못할 경우, 관련 파일이 존재하는지 확인하고 표준 import 문이 사용되었는지 확인하세요.

2. 버전 충돌

생성된 requirements.txt에 특정 버전이 포함되지 않을 수 있습니다. 환경에서 테스트를 통해 호환성을 확인하세요.

결론

pipreqs는 Python 프로젝트에서 의존성을 관리하는 효율적인 방법입니다. requirements.txt 파일 생성을 자동화하여 프로젝트 환경을 깔끔하고 재현 가능하게 유지할 수 있습니다.