SNU 2024-1 MLVU Project
- Python 3.10 (or higher)
- Poetry
main(default 브랜치): 최종적인 결과물 저장하는 브랜치dev: 개발용 중간 브랜치(여러 기능들 합치는 브랜치)feature/{description}: 새로운 기능이 추가되는 경우에 사용refactor/{description}: 기능 변경 없이 코드 리팩토링만을 하는 경우에 사용fix/{description}:dev브랜치로 반영하는 사소한 오류 수정 시에 사용hotfix/{description}:prod브랜치로 반영하는 긴급한 오류 수정 시에 사용
- default: Squash and merge
devtomain: Create a merge commit
- Google Python Style Guide
- Ruff를 이용하여 코드 스타일을 검사합니다. 현재 세팅은 diffusers 라이브러리와 싱크를 맞춰두었습니다. 각자 IDE에서 잘 동하는지 확인해보시고, 문제가 있으면 말씀해주세요!
# Check code styles using ruff
ruff check --fix등의 명령어를 사용해보시면 됩니다.
pyenv를 사용하셔서, 여러 버전의 파이썬을 사용하실 수 있습니다. 그리고, poetry에서는 파이썬 버전 제약을 거는 경우가 있는데, 로컬에 python 3.11이 없으시다면, pyenv 설치 후, 3.11 버전의 파이썬을 설치해주세요. 이후 global 수준에서 python 3.11을 켜주시면 됩니다. pyenv global 3.11.x
가상환경을 활성화하고 필요한 패키지를 설치합니다.
poetry shell
poetry installpyproject.toml 파일의 패키지 목록을 변경한 경우, 아래 명령을 통해 poetry.lock 파일을 최신화합니다.
poetry lock