Peacepiece API

Dev Environment Setting

환경 설정

1. 프로젝트 폴더 바로 아래에 .env.sample 파일을 복사하여 .env 파일로 만들기
2. pre-commit install 실행하기 (: pre-commit 자동화)

라이브러리 설정하기

# 가상환경 만들기
> python -m venv venv
# 가상환경 활성화
## Windows
> .\venv\Scripts\activate
## Mac
> source venv/bin/activate
## 라이브러리 설치하기
> pip install -r requirements.txt
## django 실행하기
> python manage.py migrate
> python manage.py runserver

Tip! venv exit하는법

> deactivate

Third party 설치하는 법

# install 하기
> pipenv install

# 추가 패키지 설치하기
> pipenv install 패키지명

# 가상환경 쉘 들어가기
> pipenv shell

# 단일 명령어를 가상환경 내부 python으로 돌리기
> pipenv run 명령어_블라블라

문서화 확인하는 방법

• 127.0.0.1:8000/swagger 또는 127.0.0.1:8000/redoc 접속하기

pylint 사용하기

터미널에 pylint {검사하고 싶은 파일명} 실행 출력창에 오류 내용 출력.

• Error / Waring 등이 줄 번호와 함께 표시된다.
• 10점 만점에 점수를 표시

pylint를 활용함에 있어서 유의할 것은 Pylint 메시지가 절대적이지 않음. Pylint는 오류 및 경고 메시지는 너무 장황 할 수 있으며, 실제 의도한 코드임에도 경고가 날 수 있음. 따라서 코드를 분석 할 때 특정 경고를 비활성화 해놓을 수 있음.