python poetry 설치 가이드

공식 설치 가이드 - poetry basic usage

이 게시글은  Windows, VSCode, bash터미널 기준으로 작성되었으며,

자세한 설치 방법은 공식문서를 참조할 것을 권장합니다.

 

 

1. 설치하기

터미널에 명령어 입력 - 설치 명령어는 환경마다 상이하니, 꼭 공식문서를 확인해보자.

 

curl -sSL https://install.python-poetry.org | python
                      # 또는
curl -sSL https://install.python-poetry.org | python3

 

성공적으로 설치가 되었다면, 터미널에 설치된 경로와,

해당 경로를 path에 추가하라는 문구가 나올 것이다.

해당 경로를 복사해주자.

 

 

2. 시스템 환경변수 설정

(1) windows 설정 - 시스템 환경 변수 편집

 

(2) 환경 변수 - 시스템 변수 - Path - 편집 

 

(3) 새로 만들기 클릭 후, 1번에서 복사한 경로 입력

여기까지 완료 되었다면 창을 모두 닫고, 다시 실행시켜주면 된다.

 

3. 설치 확인하기

다시 터미널로 돌아와 설치가 제대로 되었는지 확인해보자.

터미널에 아래 명령어 입력 시, 현재 설치된 버전이 나타난다. 

 

poetry --version

 

만약 poetry를 설치하고, Path에 추가했는데 찾을 수 없다고 나온다면, Path설정을 따로 해주어야한다.

공식문서 - Activating the virtual environment 를 참고해보자.

 

4. 시작해보기

아래 명령어는 Poetry를 사용하여 새로운 Python 프로젝트를 시작할 때 사용한다.

프로젝트의 이름, 버전, 저자, 라이선스 등의 정보를 입력할 수 있다.

이 정보는 pyproject.toml 파일에 저장.

(pyproject.toml 파일은 기존 requirements.txt 파일의 역할이라고 생각하면 된다.)

 

poetry init

poetry init -n

 

아래는 poetry init 입력 시 추가할 수 있는 내용들이다.

(poetry init -n을 입력 시 해당 문구를 스킵하고 바로 pyproject.toml을 생성한다.)

 

 

This command will guide you through creating your pyproject.toml config.

Package name []:
Version [0.1.0]:  
Description []:  
Author [이름 <이메일>, n to skip]:  
License []:  
Compatible Python versions [^3.11]:  

Would you like to define your main dependencies interactively? (yes/no) [yes] 

Package to add or search for (leave blank to skip):

 

5. 가상환경 실행하기

poetry shell
exit

 

poetry shell로 가상환경을 생성하고 해당 가상환경에 진입할 수 있고,

exit를 입력해서 가상환경을 종료할 수 있다.

 

 

6. 패키지 추가해보기

pip install하는 것처럼 똑같이 하면 된다.

 

poetry add <패키지 이름>
poetry remove <패키지 이름>

 

추가/제거 시 자동으로 pyproject.toml 파일에도 추가/제거가 된다.

 

 

7. pyproject.toml 파일로 의존성 패키지 설치하기

poetry install

 

pip install -r requirements.txt를 해준다고 생각하면 된다.

 

 

8. (선택사항)VSCode 프로젝트 폴더 안에 가상환경 생성하기

기본적으로 poetry는 프로젝트 폴더가 아닌 $HOME/.cache/pypoetry/virtualenvs 경로에 venv폴더를 생성한다.

 

poetry config virtualenvs.in-project true
poetry config virtualenvs.path "./.venv"

 

위 명령어들을 통해 virtualenvs.in-project를 true로 설정해주고, 기본 venv폴더의 경로를 설정해줄 수 있다.

이렇게 지정해주면, 기존 python -m venv venv 명령어를 통해 가상환경을 만들었을 때처럼, 프로젝트 폴더 내부에 venv폴더가 생성될 것이다.

 

 

9. 그 외 기능들 모아보기

 

 

 

10. 참고 문서, 블로그

Python Poetry tutorial: How to use Python Poetry

Red Eyed Coder Club Youtube

 

Poetry Basic usage

python poetry 공식문서

 

poetry 가상환경 만들기

팝콘먹구십다님 티스토리 

 

파이썬 패키지 관리툴 poetry 소개

승귤의 개발이야기 블로그

 

[Python] poetry를 사용하는 프로젝트를 vscode에서 개발할 때 interpreter를 잡는 방법

amazingguni님의 medium