[Django] django-environ 사용 방법

형상관리시에 민감한 정보를 노출을 피하고자 하는 경우에 django-environ을 설치하여 설정 값을 불러 들일 수 있습니다.

설치 링크

https://django-environ.readthedocs.io/en/latest/install.html

---

1. 설치 방법

python 설치 명령어로 설치하거나 프로젝트 최상단 하위에 requirements.txt 파일내에 django-environ을 추가하여 설치 할 수 있습니다. (requirements.txt를 사용하는 것을 권장 합니다.)

# python 설치 명령어
python -m pip install django-environ

# requirements.txt 파일 내 작성
...
django-eviron
...

2. 설정 파일 .evn 생성

requirements.txt 파일과 동일한 디렉토리 레벨에 .evn 파일을 생성합니다.

주의사항. 민감한 정보를 담기 때문에 서로 공유하는 내용이 아니라면 형상관리 툴등에 commit 하지 않는것을 권장합니다.

...
requirements.txt
.env
...

3. 설정값 작성

해당 파일의 경우 spring에서 사용하는 .properties 혹은 .yml 등의 파일처럼 key, value 형태를 하고 있습니다.

CODE_NAME=007
REAL_NAME=James Bond
AGE=58
MARRIED=false

4. settings.py 에서 불러오기

기본 설정값들을 가지고 불러오는 settings.py 파일에 설정 값들을 불러오는 방법입니다.

각각 필드에 적용된 데이터 타입에 따라 사용하는 메서드가 달라집니다.

# .env 파일을 읽어 들입니다.
environ.Env.read_env()

# .env 값을 불러오는 방법
# string 값을 불러옵니다.
env.str("CODE_NAME") # 007
env.str("REAL_NAME") # James Bond
# 정수 값을 불러옵니다.
env.int("AGE") # 58
# Boolean 값을 불러옵니다.
env.bool("MARRIED") # false