Python pipreqs 사용법

pipreqs 사용법 정리

pipreqs는 Python 프로젝트 내에서 사용된 패키지를 자동으로 감지하고 requirements.txt를 생성하는 도구입니다.

📌 1. pipreqs 설치

우선, pipreqs를 설치해야 합니다.

pip install pipreqs

설치가 완료되면 pipreqs --version 명령어로 정상적으로 설치되었는지 확인할 수 있습니다.

pipreqs --version

📌 2. requirements.txt 자동 생성

pipreqs는 특정 프로젝트 폴더에서 사용된 패키지만 추출하여 requirements.txt를 생성합니다.

pipreqs /path/to/your/project

예를 들어, 현재 작업 디렉토리에서 실행하려면 다음과 같이 입력합니다.

pipreqs .

이렇게 하면 requirements.txt가 생성됩니다.

📌 3. 기존 requirements.txt 덮어쓰기 (--force)

기존 requirements.txt가 존재하는 경우, 새로운 파일을 생성하려면 --force 옵션을 사용합니다.

pipreqs /path/to/your/project --force

이 옵션이 없으면 기존 파일이 있을 때 덮어쓰지 않습니다.

📌 4. 특정 Python 버전에 맞춰 패키지 목록 생성 (--python)

Python 3.9 환경에서 실행 중이라면 다음과 같이 명시할 수 있습니다.

pipreqs /path/to/your/project --python 3.9

📌 5. requirements.txt 파일의 저장 위치 변경 (--savepath)

requirements.txt 파일을 특정 위치에 저장하려면 --savepath 옵션을 사용합니다.

pipreqs /path/to/your/project --savepath /custom/path/requirements.txt

📌 6. 특정 디렉토리 또는 패턴 제외 (--ignore)

pipreqs가 특정 폴더를 무시하도록 설정할 수도 있습니다.
예를 들어, tests 폴더와 venv 폴더를 무시하려면:

pipreqs /path/to/your/project --ignore tests,venv

이렇게 하면 tests와 venv 폴더 내부의 Python 파일에서 import된 패키지는 requirements.txt에 포함되지 않습니다.

📌 7. requirements.txt 내용 확인 및 비교 (--diff)

현재 프로젝트에서 필요한 패키지와 기존 requirements.txt의 차이를 확인할 수도 있습니다.

pipreqs /path/to/your/project --diff

이 명령어를 실행하면 기존 requirements.txt와 비교하여 누락된 패키지나 불필요한 패키지를 확인할 수 있습니다.

📌 8. 도움말 (--help)

모든 옵션을 확인하려면 다음 명령어를 사용합니다.

pipreqs --help

📌 9. pipreqs로 requirements.txt 업데이트 및 유지보수

✅ 1) 프로젝트 시작 시 패키지 자동 추출

처음 프로젝트를 만들고, requirements.txt가 없을 경우:

pipreqs . --force

설치된 패키지들을 자동으로 requirements.txt에 저장할 수 있습니다.

✅ 2) 새로운 패키지를 설치한 후 requirements.txt 업데이트

프로젝트에 새로운 패키지를 설치했다면, pipreqs를 다시 실행해 requirements.txt를 업데이트할 수 있습니다.

pipreqs . --force

이렇게 하면 기존 패키지와 새로 추가된 패키지가 반영됩니다.

📌 10. pipreqs 사용 예시

🔹 예제 프로젝트 폴더 구조

my_project/
│── main.py
│── utils.py
│── data_processing/
│   │── loader.py
│   └── transformer.py
└── tests/
    └── test_loader.py

위 프로젝트에서 pipreqs . --ignore tests를 실행하면 tests/ 폴더를 제외한 모든 Python 파일에서 import된 패키지들을 기반으로 requirements.txt가 생성됩니다.

🔹 예제 실행

pipreqs . --ignore tests

출력 결과:

INFO: Successfully saved requirements file in ./requirements.txt

🔹 생성된 requirements.txt 예시

numpy==1.23.5
pandas==1.5.3
scikit-learn==1.2.2
matplotlib==3.6.3

이제 이 파일을 사용하여 다른 환경에서 패키지를 설치할 수 있습니다.

pip install -r requirements.txt

🎯 요약