Django Settings Modularization

Django 프로젝트의 settings 모듈화와 배포 가이드를 작성했습니다. 주요 개선사항은 다음과 같습니다:

주요 개선사항

1. Settings 모듈화
   • settings/ 디렉토리 구조로 환경별 설정 분리
   • base.py: 공통 설정
   • local.py: 개발 환경 전용
   • production.py: 운영 환경 전용
2. 보안 강화
   • SECRET_KEY를 환경 변수로 관리
   • 운영 환경에서 보안 헤더 설정 추가
   • DEBUG 모드 환경별 자동 설정
3. 데이터베이스 설정 개선
   • 환경 변수를 통한 DB 설정 관리
   • MySQL 문자셋 설정 추가 (utf8mb4)
4. 배포 자동화
   • deploy.sh: 로컬에서 GitHub 푸시
   • pull_and_deploy.sh: PythonAnywhere에서 배포 실행
5. 로깅 개선
   • RotatingFileHandler로 로그 파일 크기 관리
   • 환경별 로그 레벨 설정

적용 방법

1. 프로젝트 구조 변경

 

bash

cd project/
mkdir settings
touch settings/__init__.py settings/base.py settings/local.py settings/production.py

1. 환경 파일 생성

 

bash

# 프로젝트 루트에서
touch .env_local .env_prod

1. 기존 settings.py 백업

 

bash

mv settings.py settings_backup.py

1. 새로운 설정 파일들 적용
   • 위 가이드의 코드를 각 파일에 복사
2. 배포 스크립트 실행 권한 부여

 

bash

chmod +x deploy.sh
# PythonAnywhere에서
chmod +x pull_and_deploy.sh

이 구조를 사용하면 개발과 운영 환경을 명확히 분리하여 관리할 수 있고, 실수로 운영 설정이 개발 환경에 적용되거나 그 반대의 경우를 방지할 수 있습니다.

 

---

Django Settings 모듈화 및 배포 가이드

1. Settings 모듈 구조

프로젝트의 settings를 다음과 같은 구조로 재구성합니다:

project/
├── settings/
│   ├── __init__.py
│   ├── base.py      # 공통 설정
│   ├── local.py     # 개발 환경 설정
│   └── production.py # 운영 환경 설정

2. 환경 파일 설정

.env_local (개발 환경)

# 개발 환경 설정
DEBUG=True
SECRET_KEY=your-development-secret-key-here
DATABASE_URL=sqlite:///db.sqlite3
ALLOWED_HOSTS=127.0.0.1,localhost
ENVIRONMENT=local

.env_prod (운영 환경)

# 운영 환경 설정
DEBUG=False
SECRET_KEY=your-production-secret-key-here
DATABASE_NAME=xxxxx
DATABASE_USER=xxxxx
DATABASE_PASSWORD=xxxxx
DATABASE_HOST=cskang.mysql.pythonanywhere-services.com
DATABASE_PORT=3306
ALLOWED_HOSTS=movie.thesysm.com
ENVIRONMENT=production

3. Settings 파일 구성

project/settings/__init__.py

import os
from dotenv import load_dotenv

# 환경에 따라 적절한 .env 파일 로드
environment = os.getenv('ENVIRONMENT', 'local')
if environment == 'production':
    load_dotenv('.env_prod')
else:
    load_dotenv('.env_local')

# 환경에 따라 적절한 settings 모듈 import
if environment == 'production':
    from .production import *
else:
    from .local import *

project/settings/base.py

"""
Django 공통 설정
"""
import os
from pathlib import Path

# Build paths
BASE_DIR = Path(__file__).resolve().parent.parent.parent

# Security settings
SECRET_KEY = os.getenv('SECRET_KEY', 'django-insecure-default-key')

# Application definition
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    'corsheaders',
    'phrase',
    'api',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'corsheaders.middleware.CorsMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

ROOT_URLCONF = 'project.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates'],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

WSGI_APPLICATION = 'project.wsgi.application'

# Password validation
AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]

# Internationalization
LANGUAGE_CODE = 'ko-kr'
TIME_ZONE = 'Asia/Seoul'
USE_I18N = True
USE_TZ = True

# Static files
STATIC_URL = '/static/'
STATICFILES_DIRS = [
    BASE_DIR / 'static',
]

# Media files
MEDIA_URL = '/media/'
MEDIA_ROOT = BASE_DIR / 'media'

# Default primary key field type
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

# REST Framework
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10,
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
    ],
    'DEFAULT_PARSER_CLASSES': [
        'rest_framework.parsers.JSONParser',
    ],
}

# Logging
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
            'style': '{',
        },
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'verbose',
        },
        'file': {
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': 'logs/django.log',
            'maxBytes': 1024 * 1024 * 15,  # 15MB
            'backupCount': 10,
            'formatter': 'verbose',
        },
    },
    'root': {
        'handlers': ['console', 'file'],
        'level': 'INFO',
    },
    'loggers': {
        'django': {
            'handlers': ['console', 'file'],
            'level': os.getenv('DJANGO_LOG_LEVEL', 'INFO'),
            'propagate': False,
        },
    },
}

project/settings/local.py

"""
개발 환경 설정
"""
import os
from .base import *

DEBUG = True

ALLOWED_HOSTS = os.getenv('ALLOWED_HOSTS', '127.0.0.1,localhost').split(',')

# Database
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

# CORS settings for development
CORS_ALLOW_ALL_ORIGINS = True

# Static files
STATIC_ROOT = BASE_DIR / 'staticfiles'

# Development-specific apps
INSTALLED_APPS += [
    'django_extensions',  # 유용한 개발 도구
]

# Email backend for development
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

project/settings/production.py

"""
운영 환경 설정
"""
import os
from .base import *

DEBUG = False

ALLOWED_HOSTS = os.getenv('ALLOWED_HOSTS', '').split(',')

# Database
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': os.getenv('DATABASE_NAME'),
        'USER': os.getenv('DATABASE_USER'),
        'PASSWORD': os.getenv('DATABASE_PASSWORD'),
        'HOST': os.getenv('DATABASE_HOST', 'localhost'),
        'PORT': os.getenv('DATABASE_PORT', '3306'),
        'OPTIONS': {
            'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",
            'charset': 'utf8mb4',
        },
    }
}

# Security settings
SECURE_SSL_REDIRECT = True
SESSION_COOKIE_SECURE = True
CSRF_COOKIE_SECURE = True
SECURE_BROWSER_XSS_FILTER = True
SECURE_CONTENT_TYPE_NOSNIFF = True
X_FRAME_OPTIONS = 'DENY'

# CORS settings for production
CORS_ALLOWED_ORIGINS = [
    "https://movie.thesysm.com",
    "https://ganzskang.pythonanywhere.com",
]

# Static files
STATIC_ROOT = '/home/ganzskang/djstatic'

# Media files
MEDIA_ROOT = '/home/ganzskang/media'

# Email backend for production
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = os.getenv('EMAIL_HOST', 'smtp.gmail.com')
EMAIL_PORT = os.getenv('EMAIL_PORT', 587)
EMAIL_USE_TLS = True
EMAIL_HOST_USER = os.getenv('EMAIL_HOST_USER')
EMAIL_HOST_PASSWORD = os.getenv('EMAIL_HOST_PASSWORD')

4. requirements 파일 분리

requirements/base.txt

Django==5.2
djangorestframework==3.15.0
django-cors-headers==4.3.0
python-dotenv==1.0.0
mysqlclient==2.2.0
Pillow==10.2.0

requirements/local.txt

-r base.txt
django-extensions==3.2.3
ipython==8.20.0

requirements/production.txt

-r base.txt
gunicorn==21.2.0

5. 배포 스크립트

6. 개발 워크플로우

개발 환경 설정

# 가상환경 생성 및 활성화
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# 환경 변수 설정
export ENVIRONMENT=local

# 패키지 설치
pip install -r requirements/local.txt

# 마이그레이션
python manage.py makemigrations
python manage.py migrate

# 개발 서버 실행
python manage.py runserver

운영 환경 배포

# 1. 로컬에서 변경사항 커밋 및 푸시
./deploy.sh

# 2. PythonAnywhere 콘솔에서
./pull_and_deploy.sh

7. 추가 권장사항

.gitignore 파일

# Python
__pycache__/
*.py[cod]
*$py.class
*.so
.Python
venv/
env/

# Django
*.log
db.sqlite3
media/
staticfiles/
static_root/

# Environment
.env
.env_local
.env_prod

# IDE
.vscode/
.idea/
*.swp
*.swo

# OS
.DS_Store
Thumbs.db

로그 디렉토리 생성

# 프로젝트 루트에서
mkdir -p logs

SECRET_KEY 생성

# Django shell에서 새로운 SECRET_KEY 생성
from django.core.management.utils import get_random_secret_key
print(get_random_secret_key())

이 구조를 사용하면 개발과 운영 환경을 깔끔하게 분리하여 관리할 수 있으며, 환경별 설정을 쉽게 전환할 수 있습니다.