Tip2 - dotenv

dotenv

 

앱이나 웹 등의 개발을 하다 보면 DB나 API Key 같은, 유출하면 안 되는 정보들이 있다. 

그런데 개발자라면 GitHub를 반듯이 사용할 것인데 앞서 설명한 중요한 정보들이 Git에 저장되면 안 된다.

 

그래서 오늘은 DB나 API Key 등의 중요 정보를 관리하는 env파일과 GitHub에 올릴 때, 올리면 안 되는 파일을 제외할 수 있는 gitignore에 대해 알아보자

 

1. env(환경변수 파일)

1-1) env파일 생성

python의 경우 아래 명령어를 통해 설치할 수 있다. 

pip install python-dotenv

 

env파일은 디렉토리의 최상단에 위치한다.

 

env파일에는 다음과 같이 중요한 환경변수를 저장하면 된다. 

# .env

API_KEY = "Your API Key"
API_SECRET = "Your API SECRET"

 

1-2) env 사용하기

.env에서 작성한 변수들을 사용하려면, 사용할 파일에서 불러오면 된다.

# main.py

from dotenv import load_dotenv
import os
load_dotenv()


API_KEY = os.environ.get("API_KEY")
API_SECRET = os.environ.get("API_SECRET")

 

 

2. gitignore

.gitignore은 Github에 올릴 때 어떤 파일을 제외하고 올릴지 결정하는 파일이다. 

 

간단하게 .gitignore파일을 생성하고 파일 안에 .env를 작성하면 끝난다.

# .gitignore

.env

 

 

이렇게 작성하면 git에 올릴 때 .env파일과 같은 중요파일을 제외하고 올릴 수 있다.