개발 세팅 - 100-hours-a-week/5-yeosa-wiki GitHub Wiki

1. 초기 1회 세팅: vscode 확장 ruff, mypy type checker를 설치한다

image image 1

2. git clone할 때마다 세팅

a. 레포 클론

git clone https://github.com/100-hours-a-week/5-yeosa-ongi-ai.git
cd 5-yeosa-ongi-ai

b. 브랜치 이동

git checkout <브랜치명>
# 예시: git checkout feat/#5

c. 파이썬 버전 확인

python --version

  • 만약 python3으로 사용하라고 하면, 아래의 설정을 해주세요

    sudo ln -sf $(which python3) /usr/bin/python

  • 만약 시스템에 설치된 파이썬 버전 중에 3.10.6이 없다면 먼저 설치해주세요!

  • 설치 명령어

    • pyenv 설치

      sudo apt update
sudo apt install -y build-essential curl git \
libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev \
llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev \
libffi-dev liblzma-dev python-openssl

git clone https://github.com/pyenv/pyenv.git ~/.pyenv

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(pyenv init --path)"' >> ~/.bashrc
echo 'eval "$(pyenv init -)"' >> ~/.bashrc

source ~/.bashrc
    pyenv install 3.10.6

  • python —version 결과로 Python 3.10.6이 뜬다면 pyenv 버전 설정은 건너뛰기

d. pyenv로 버전 설정

pyenv local 3.10.6
python --version

e. 가상환경 생성 및 활성화

python -m venv .venv
source .venv/bin/activate

f. pip 업그레이드

pip install --upgrade pip

g. 패키지 설치

pip install -r requirements.txt
pip install -r requirements_dev.txt

h. 인터프리터 선택

  • 코드 열어서 스타일 경고 밑줄이 띄워져 있다면 인터프리터가 이미 설정되어 있는 것입니다.

image 2 image 3

  • 첫 번째 사진의 우측 하단에 인터프리터 선택 클릭
  • 인터프리터 선택 옵션 중 ./.venv/bin/python 선택하기

i. 결과

image 4

  • ctrl+s로 코드 저장하면 경고선으로 컨벤션에 맞지 않는 코드 확인 가능합니다.

3. 이용 방법

a. ruff 명령어 이용 방법

# 코드 스타일 문제 검사
ruff check .
ruff check test.py

# 코드 스타일 문제 중 자동 수정 가능한 부분 수정
ruff check . --fix
ruff check test.py --fix

# black 스타일 기반 코드 포맷
ruff format .
ruff format test.py

check —fix와 format의 차이점

check —fix는 문제 있는 부분만 최소 수정합니다.

format은 전체 코드를 black 스타일로 깔끔히 정리합니다.

b. mypy 이용 방법

# 타입 힌트 검사
mypy .
mypy test.py
⚠️ **GitHub.com Fallback** ⚠️