TIL39. Django : Project Settings

📌 이 포스팅에서는 Django 프로젝트를 위한 초기 세팅에 대해 정리하였습니다.

🌈 Project Settings

🔥 가상환경 생성 및 프로젝트 구성

🔥 Django와 MySQL 연결 준비

🔥 settgins.py 설정

🔥 git & .gitignore 설정

Step1. 가상환경 생성 및 프로젝트 구성

🤔 가상환경 생성

✔️ item2에서 프로젝트를 위한 새로운 가상환경을 생성하고, 활성화 시킨다.

$ conda create -n [가상환경명] python=3.8 👈 가상환경 생성

$ conda env list 👈 생성한 가상환경 리스트 확인

$ conda activate [가상환경명] 👈 가상환경 활성화

🤔 프로젝트 생성

✔️ 가상환경이 활성화된 상태에서 Django를 설치하고, Project를 만든다.

$ pip install django 👈 django 최신 버전 설치

$ pip freeze 👈 설치된 프로그램 확인

$ django-admin startproject [프로젝트명] 👈 django 프로젝트 생성

2. Django와 MySQL 연결 준비

🤔 데이터베이스 생성 및 mysqlclient 설치

✔️ 가상환경이 활성화된 상태에서 mysqlclient를 설치해준다.

$ pip install mysqlclient 👈 django 최신 버전 설치

✔️ mysql이 설치된 상태에서 mysql로 진입해 데이터베이스를 생성해 준다. 이는 추후 django settings.py에서 sqllite3를 대체하기 위함이다.

$ mysql -u root -p 👈 비밀번호를 입력해 root 사용자로 mysql 진입

mysql> create database [DB이름] character set utf8mb4 collate utf8mb4_general_ci; 👈 DB 생성

mysql> show databases 👈 DB 생성 확인

✔️ root사용자로 mysql에 진입한 상태에서 원한다면 아래처럼 비밀번호를 변경할 수 있다.

mysql> ALTER USER 'root'@'localhost' IDENTIFIED WITH caching_sha2_password BY '[변경할 비밀번호]'; 👈 비밀번호 변경

3. Django settgins.py

🤔 IP 허용(화이트리스트 기반)

✔️ 여기까지 완료했다면, Django settgins에서 몇가지 settgins을 다뤄보자.

ALLOWED_HOSTS = ['*'] 👈 IP 전부 허용

🤔 SECRET_KEY 및 DATABASES 은폐시키기

✔️ manage.py와 같은 level에 python파일을 만들어 여기에 민감한 정보를 숨기고, 이 파일을 .gitignore에 추가시킴으로써 노출시키지 않아야 한다.
✔️ 생성한 파일에 아래 내용을 붙여넣고, 실제 정보와 매핑 시킨다.

# my_settings.py
DATABASES = {
    'default' : {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'DATABASE 명',  # 👈 mysql에서 생성한 DB명
        'USER': '사용자명', # 👈 root를 적어준다.
        'PASSWORD': 'DB접속용 비밀번호', # 👈 mysql 비밀번호
        'HOST': '127.0.0.1',
        'PORT': '3306',
		'OPTIONS': {'charset': 'utf8mb4'}
    }
}
SECRET_KEY = 'settings.py의 secret_key' # 👈 SECRET_KEY

✔️ settgins.py 최상단에 위 정보가 존재하는 파일을 가져와 연동시킨다.

from my_settings import DATABASES, SECRET_KEY
....
....
SECRET_KEY = SECRET_KEY  # 👈 기존 정보 삭제 후, import한 변수와 연결짓는다.
....
....
DATABASES = DATABASES  # 👈 sqllite3 관련 정보 삭제 후, import한 변수와 연결짓는다.
....
....

🤔 Application & MiddleWare

✔️ Django 프레임워크에서 기본으로 제공하는 기능 중 불필요한 기능(admin, csrf, auth)은 아래처럼 주석처리 해서 가볍게 만들어준다.
✔️ Application의 복잡성을 줄이기 위해 3개 파트로 분류하였다.
✔️ 가상환경 내 corsheaders 설치 및 application & middleware 등록

$ pip install django-cors-headers 👈 corsheaders

# Application definition
DJANGO_APPS = [
    # 'django.contrib.admin', # 👈 admin 기능 주석
    # 'django.contrib.auth', # 👈 auth 기능 주석
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
]
PROJECT_APPS = []
THIRD_PARTY_APPS = [
    "corsheaders",  # 👈 corsheaders 앱 등록
]
INSTALLED_APPS = DJANGO_APPS + PROJECT_APPS + THIRD_PARTY_APPS
MIDDLEWARE = [
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.common.CommonMiddleware",
    # 'django.middleware.csrf.CsrfViewMiddleware', # 👈 csrf 기능 주석
    # 'django.contrib.auth.middleware.AuthenticationMiddleware', # 👈 authentication 기능 주석
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.middleware.clickjacking.XFrameOptionsMiddleware",
    "corsheaders.middleware.CorsMiddleware", # 👈 corsheaderMiddleWare 등록
]

✔️ settgins.py 최하단 부의 CORS 관련 설정을 추가시킨다.

##CORS
CORS_ORIGIN_ALLOW_ALL=True
CORS_ALLOW_CREDENTIALS = True
CORS_ALLOW_METHODS = (
    'DELETE',
    'GET',
    'OPTIONS',
    'PATCH',
    'POST',
    'PUT',
)
CORS_ALLOW_HEADERS = (
    'accept',
    'accept-encoding',
    'authorization',
    'content-type',
    'dnt',
    'origin',
    'user-agent',
    'x-csrftoken',
    'x-requested-with',
)

✔️ 현재까지의 settgins에 문제가 없는지 중간 점검 한다. 아래와 같다면 정상이다. 빨간글씨는 아직 migrations를 진행하지 않았기 때문이니 괜찮다.

$ python manage.py runserver 👈 서버 구동

4. git & .gitignore 설정

🤔 .gitignore 파일 생성

✔️ manage.py가 있는 level에 .gitignore을 생성한다.
✔️ .gitignore에 추가할 정보를 "https://www.toptal.com/developers/gitignore" 에서 생성 후 붙여넣는다.
✔️ python, pycharm, VisualStudioCode, vim, macOS, Linux, zsh 관련 정보를 .gitignore에 추가하였다.
✔️ 이와 함께 SECRET_KEY와 DATABASE 정보를 분리시켜 둔 python 파일을 .gitignore에 추가한다.

# .gitignore
my_settings.py

🤔 git 간단 명령

$ git init 👈 git 초기화

$ git remote add origin [github repository url] 👈 원격 repository 연결

$ git commit -am "내용" 👈 add & commit

$ git branch -M main 👈 master 명칭 main으로 변경

$ git branch [branch명] 👈 branch 생성

$ git checkout [branch명] 👈 해당 branch 전환

$ git checkout -b [branch명] 👈 branch 생성 후 이동

$ git push origin "브런치명" 👈 github로 push

🙏 느낀점.

✔️ 혼자 공부할 때, django-admin startproejct [프로젝트명] . 을 통해 프로젝트를 생성했었다. 보통 django-admin startproejct config . 로 만들었다. project 디렉토리를 app 디렉토리와 같은 계층에 위치시켰었는데, 점(.)을 붙이지 않으면 발생하는 디렉토리의 깊이 때문에 불편했기 때문이다. 이번에도 점(.)을 이용해 프로젝트를 생성했다가 다시 듀토리얼대로 따라가보았다. 팀 프로젝트 시, 다른 트리구조로 인한 문제가 염려되기도하고, 한번 더 연습해볼 생각으로 진행했다. 처음에는 pipenv가 가장 편하다고 느꼈는데 이제는 miniconda로 가상환경을 활성화하여 하는 작업이 점차 익숙해지는 것 같다.

✔️ SECRET_KEY 등 은폐가 필요한 정보를 별도로 저장하고 .gitignore에 등록하기 위해 Django에서 제공하는 dotenv를 사용했었는데, 그냥 파일로 만들어 import 처리하는 방법이 더 간편하게 느껴졌다. 분명 어떤 차이가 있을것 같은데 찾아봐야겠다.

✔️ 몇 번의 간단한 Django 클론코딩을하며, 프론트쪽과 통신하는 의미에대해서 '무엇을 어떻게 하는지'에 대한 의문이 있었는데, CORS의 등장으로 어떤 것을 공부해야할지 알게된 것같다. SOP 개념부터 시작해서 origin, fetch 등에 대해 알아봐야겠다.