글길 백엔드

개요

글길 백엔드 저장소입니다.

요구사항

• Python 3.7+

설치하는 법

• Python 설치

  다른 방법으로 설치하셔도 무방하나 pyenv를 기준으로 설명합니다

  • pyenv 설치

    $ brew install pyenv
    

  • python 3.7+ 설치

    그냥 설치하면 sqlite3를 못 찾아서 CFLAGS를 붙여서 설치합니다.

    $ CFLAGS="-I$(xcrun --show-sdk-path)/usr/include" pyenv install <Python Version>
    $ pyenv shell <Python Version>
    

• virtualenv 세팅

  다른 라이브러리를 사용하셔도 무방합니다

  $ mkvirtualenv -a `pwd` -p $(which python) venv
  

• 필요한 환경 변수 셋팅

  우리말샘 API 토큰

  $ export WORD_API_TOKEN=<Token>
  

• dependencies 설치

  $ ./scripts/install.sh
  

  만약 flake8 실행시 segmentation fault가 발생한다면 재설치하거나 venv 밖의 flake8을 사용해주세요.

• 데이터베이스를 세팅합니다.

  $ createdb word-way
  $ alembic upgrade head

  • 단어 데이터를 준비하려면 스크립트를 실행합니다.

    $ python init_word.py -c dev

데이터베이스 마이그레이션

• 작업 중에 모델 변경이 있을 때 새로운 리비전을 생성해줍니다.

  alembic revision --autogenerate

• 모델 변경이 포함된 코드를 pull 받았을 때 DB를 업그레이드 해줍니다.

  alembic upgrade head

실행하는 법

• dev.conf 파일을 생성합니다.

  $ cp conf/dev.conf.example conf/dev.conf

• 웹 서버를 실행합니다.

  $ ./run.py -d -c dev

• 워커를 실행합니다.

  $ celery -A word_way worker --config dev

Docker로 실행하기

1. 이미지를 빌드합니다.

   docker build -t word-way/backend .

2. 컨테이너를 실행합니다.

   docker run --rm -d -p <Port Number You Want>:2222 -v $PWD/word_way:/app/word_way word-way/backend:latest

Swagger 문서 확인

API endpoint 끝에 /doc을 붙여 확인 할 수 있습니다.

e.g.

• http://:/api/words/doc/