Python - pip와 requirements.txt로 패키지 관리

pythonetc

파이썬 오픈 소스 프로젝트를 다운로드 받아서 설치해봤다면, requirements.txt로 파이썬 패키지를 설치했던 것을 경험했을 것입니다.

pip install -r requirements.txt

프로젝트에 필요한 의존성 패키지들을 requirements.txt 파일에 정의하고, pip 명령어로 쉽게 설치하도록 도와줍니다.

1. requirements.txt 파일 양식

requirements.txt에는 의존성 패키지(설치되어야하는 패키지)가 정의되어있는데요. 명시한 패키지와 버전에 해당하는 것을 pip가 설치합니다.

아래 파일은 requirements.txt의 예제이며, https://pip.pypa.io에서 가져왔습니다.

  • 버전 없이 패키지 이름만 입력할 수 있음
  • 패키지 이름과 버전 이름을 함께 입력할 수 있음
  • 패키지 이름과, 최소 버전을 입력할 수 있음
  • 특정 버전을 제외한 버전, 호환 가능한 버전을 명시
#
####### example-requirements.txt #######
#
###### Requirements without Version Specifiers ######
nose
nose-cov
beautifulsoup4
#
###### Requirements with Version Specifiers ######
#   See https://www.python.org/dev/peps/pep-0440/#version-specifiers
docopt == 0.6.1             # Version Matching. Must be version 0.6.1
keyring >= 4.1.1            # Minimum version 4.1.1
coverage != 3.5             # Version Exclusion. Anything except version 3.5
Mopidy-Dirble ~= 1.1        # Compatible release. Same as >= 1.1, == 1.*

버전의 비교 구문에 대한 자세한 설명은 다음과 같으며, peps.python.org를 참고하였습니다.

  • ~=: Compatible release clause
  • ==: Version matching clause
  • !=: Version exclusion clause
  • <=, >=: Inclusive ordered comparison clause
  • <, >: Exclusive ordered comparison clause
  • ===: Arbitrary equality clause.

2. pip로 requirements.txt의 패키지 설치

아래와 같은 명령어를 사용하면 requirements.txt에 정의된 패키지를 pip가 모두 설치합니다.

  • -r 옵션은 requirements.txt 파일로 패키지를 설치한다는 의미
pip install -r requirements.txt

requirements.txt의 파일 이름은 requirements.txt가 아니여도 됩니다. 하지만 관례적인 이름을 사용하는 것이 다른 사람들이 파일의 의미를 이해하는데 도움을 줄 수 있습니다.

3. 설치된 모든 패키지를 requirements.txt로 만들기

다음 명령어로 현재 시스템에 설치된 모든 패키지를 확인할 수 있습니다.

$ pip list
Package                  Version             
------------------------ --------------------
aiodns                   3.0.0               
aiohttp                  3.7.4.post0         
apiclient                1.0.4               
apturl                   0.5.2               
async-generator          1.10                
async-timeout            3.0.1               
...

위의 모든 패키지들로 requirements.txt를 만드려면, 아래와 같은 명령어를 사용하면 됩니다.

$ pip freeze > requirements.txt

requirements.txt 파일을 열어보면 아래와 같이 보입니다.

aiodns==3.0.0
aiohttp==3.7.4.post0
apiclient==1.0.4
apturl==0.5.2
async-generator==1.10
async-timeout==3.0.1
attrs==21.2.0
autokey==0.95.10
Automat==0.8.0
backcall==0.1.0
backports.zoneinfo==0.2.1
....
Loading script...

Related Posts

codechachaCopyright ©2019 codechacha