[python] Environ or python-dotenv

사용하는 이유

파이썬 예제에서 twitter api, spotify api 등을 활용하는 것을 볼 수 있습니다. 

위와 같은 api를 활용하려면 private key, public key가 필요합니다. 

다만, private key 의 경우 외부 노출이 되면 안되기 때문에 스크립트에 직접적으로 쓰지 않고

환경 변수로 사용을 합니다. 

 

이런 상황에 필요한 패키지가 environ 혹은 dotenv 입니다. 

---

Environ

환경 변수값 만들기 

python dictionary 처럼 만드시면 됩니다. 

>> import os
>> os.environ['github_api_key'] = 'my_api_key'

 사용하기

>> import os
>> api_key = os.environ.get('github_api_key')
>> print(api_key)

'my_api_key'

저장한 environ 값 삭제하기 

>> import os
>> os.environ.pop('github_api_key')

# 전체 값을 삭제할 경우
>> os.environ.clear()

 

---

Dotenv

설치 

# window
pip install python-dotenv

# mac
pip3 install python-dotenv

터미널에서 .env 파일 생성

GUI 에서 생성하셔도 무방합니다. 

touch .env

.env 파일

GITHUB_API_KEY = MY_API_KEY

사용하기 

import os
from dotenv import load_dotenv

load_dotenv()

api_key = os.getenv('github_api_key')

주의점 : dotenv를 사용하실 경우 github repo에 push 하실 때 .gitignore에 꼭 .env 를 추가해주세요. 

 

 

개인적으론 python-dotenv 를 더 선호합니다. 

environ 의 경우 global 환경 변수로 하드 코딩을 해야 하며,

터미널 새로 열 때 마다 다시 declare 필요하기 때문에 개인적으론 좋아하지 않습니다.