번외2. 파이썬 Boilerplate 구성 (Python, Docker, DevContainer, Pipenv)

해당 글은 완성 되었으나. 필자의 경험에 따라 업데이트 할수도 있습니다. (글 내용이 바뀔수 있다는 뜻) 더 편리한 구조를 찾으면 바꾸겠습니다. 피드백 부탁드립니다.

 

여러가지 실험을 위해 파이썬 프로젝트를 만들어야하는 경우가 많다보니 Boilerplate를 하나정도 만들어서 운용하는게 효율적이겠다라는 생각이 들어 만들면서 과정을 정리해보려고 한다.

github repository

 

Devcontainer 설정

devcontainer는 Docker기반의 개발환경을 VScode에 만들어주는 도구인데 최근 협업을 위해 사용했는데 매우 편리했던 기억이 있어서 이것을 설정해보려고 한다. 

 

Docker에 대해서 어느정도 알고있다는 것을 전제로 커스텀 해야할 부분만 써내려가 보겠다.

 

dev container extension

우선 VS code에서 다음의 확장 프로그램을 설치해야한다.

 

그 다음 프로젝트에 .devcontainer 설정을 추가해야하는데 나는 그냥 Docker가 아닌 Docker compose를 사용하도록 설정하려고한다.

아래 레파지토리에서는 공식적인 Devcontainer 설정 템플릿을 제공하고 있으니 다음을 기반으로 설정하면 된다.

vscode-dev-containers/containers/python-3 at main · microsoft/vscode-dev-containers

 

.devcontainer extension setting

.devcontainer를 만들때 docker 컨테이너가 만들어지고 내부에 설치될 vscode의 extension을 지정할 수있는데

@enabled라고 검색하면 다음과 같이 사용중인 extension이 나오는데 이를 extension id copy해서 이런식으로 쭉쭉 추가해주면 된다.

.devcontainer

.devcontainer설정은 크게 별거는 없고 어떤 compose 나 docker 파일을 실행할것인지 선택하고 

workspace path를 지정해주면 vscode 로컬소스가 workspace위치에 복사된다. 여기서 git commit과 push가 문제없이 잘 된다.

 

Github Package 관리설정

이전 글에서 env관리하는데 굉장히 편리하다고 느꼈던 pipenv를 이용해 보려고 한다.

짧은 코드지만 이렇게 만드는데 많은 시행착오가 있었다. pipenv의 버전 문제라던지,, 풀버전으로 명시를 안하면 종속성이 안붙는다던지.

DockerFile & main.py

파이썬 이미지를 설치하는 도커 파일이다. 파이썬환경에 맞게 하도록 설정했다.

또한 포트 설정까지 해서 작동을 테스트했다.

 

VScode Task Setting

Live2d SDK 까보다가 알게된 기능인데 편리해서 추가해봤다.

Control+Shift+B 로 기본설정한 Task를 자동으로 실행 가능하고

Control+Shift+P 로 사용가능한 Task를 조회, 실행 할 수 있다.

.vscode/task.json

2개 이상 Task를 넣으면 다음과 같이 Path 이동 없이 편리하게 쓸 수 있다.

프로젝트 진행시 Path가 복잡해지면 이렇게 쓰는게 좋아보인다.

Docker compose로 프로젝트가 복잡해졌을경우 아주 유용할 것으로 보인다.

Control+Shift+P > Tasks: Run Task

 

Repository

내가 사용하려고 만들었지만 모두 편리하게 사용했으면 좋겠다.

사용방법은 해당 레파지토리의 README에 작성해놓을테니 참고하면 된다.

GitHub - lunaB/Boilerplate-Python: Boilerplate Python