requirements.txt 제대로 관리하는 방법

Python 개발, 특히 협업할 때 패키지 관리가 얼마나 중요한지 아시나요?

requirements.txt 파일 하나 제대로 관리하면 개발 효율이 엄청나게 올라갑니다.

반대로 관리가 엉망이면 "잘 되던 코드가 왜 안 돌아가지?" 하면서 디버깅 지옥에 빠질 수 있습니다.

 

requirements.txt, 왜 중요할까요?

 

requirements.txt 파일은 프로젝트에 필요한 모든 Python 라이브러리와 그 버전을 기록해둔 '패키지 목록'입니다.

이 파일 덕분에 다른 개발자들과 동일한 환경을 쉽게 구축하고, 배포 과정에서 발생할 수 있는 의존성 문제를 해결할 수 있습니다.

마치 맛집 레시피처럼, requirements.txt는 프로젝트를 성공적으로 실행하기 위한 필수 재료 목록인 셈이죠.

 

requirements.txt, 어떻게 만들까요?

 

가장 일반적인 방법은 `pip freeze > requirements.txt` 명령어를 사용하는 것입니다.

이 명령어는 현재 활성화된 가상 환경에 설치된 모든 패키지와 그 버전을 requirements.txt 파일에 기록합니다.

정말 간단하죠?

 

conda 환경이라면?

 

conda 환경과 pip를 혼용해서 패키지를 설치했다면 `pip freeze` 명령어가 제대로 작동하지 않을 수 있습니다.

이럴 때는 `pip list --format=freeze > requirement_pip_list.txt` 명령어를 사용해보세요.

conda를 통해 설치했든, pip를 통해 설치했든 모든 패키지 목록을 문제없이 추출할 수 있습니다.

 

requirements.txt, 어떻게 사용할까요?

 

requirements.txt 파일이 있다면, 다른 환경에서도 손쉽게 동일한 패키지들을 설치할 수 있습니다.

`pip install -r requirements.txt` 명령어를 실행하면 requirements.txt 파일에 명시된 모든 패키지를 한 번에 설치할 수 있습니다.

새로운 개발자가 합류했을 때, 혹은 서버에 배포할 때 이 명령어 하나면 환경 설정이 끝납니다.

 

requirements.txt, 이렇게 관리하세요!

 

* 가상 환경 필수: 프로젝트마다 독립적인 가상 환경을 만들고, 그 환경 안에서 패키지를 설치하세요. 이렇게 하면 패키지 충돌을 방지하고, requirements.txt 파일을 깔끔하게 유지할 수 있습니다.

* 정기적인 업데이트: 프로젝트의 의존성이 변경될 때마다 requirements.txt 파일을 업데이트하세요. 새로운 패키지를 설치하거나, 기존 패키지의 버전을 업데이트했다면 반드시 `pip freeze > requirements.txt` 명령어를 다시 실행해야 합니다.

* 불필요한 패키지 제거: 더 이상 사용하지 않는 패키지는 가상 환경에서 삭제하고, requirements.txt 파일에서도 제거하세요. requirements.txt 파일이 깔끔할수록 패키지 관리도 쉬워집니다.

* 보안 취약점 검사: 요즘에는 requirements.txt 파일을 분석하여 보안 취약점이 있는 패키지를 자동으로 찾아주는 도구들도 많습니다. 이러한 도구를 활용하여 프로젝트의 보안을 강화하세요.

 

requirements.txt 파일 관리는 귀찮은 일이 아니라, 프로젝트의 안정성과 생산성을 높이는 핵심적인 습관입니다.

지금 당장은 조금 번거롭게 느껴질 수 있지만, 장기적으로 봤을 때 훨씬 더 큰 이득을 얻을 수 있습니다.

그러니 오늘부터 requirements.txt 파일을 꼼꼼하게 관리하고, 더 즐겁고 효율적인 Python 개발을 경험해보세요!