[python] 버전 관리 시 python-dotenv 파일의 관리 방법
개발 과정에서 .env 파일은 주요한 환경 변수와 설정 값을 저장하는 데 널리 사용됩니다. .env 파일은 python-dotenv 라이브러리를 사용하여 파이썬 프로젝트에서 로드하는 것이 일반적입니다. 그러나 버전 관리를 할 때 .env 파일을 함께 관리할지 말지에 대한 의문이 생깁니다.
이 글에서는 .env 파일을 버전 관리 시스템에서 관리하는 방법에 대해 알아보겠습니다.
왜 .env 파일을 버전 관리해야 할까요?
.env파일에는 중요한 설정 값을 저장합니다. 따라서.env파일을 공유하여 일관된 개발 환경을 유지할 수 있습니다..env파일이 누락되면 프로젝트를 정상적으로 실행할 수 없습니다. 버전 관리를 통해.env파일을 복원하는 데 드는 노력을 줄일 수 있습니다..env파일은 개발 환경과 배포 환경에서 다른 값들을 가지기 때문에, 버전 관리를 통해 이러한 환경 간의 차이를 추적할 수 있습니다.
.env 파일을 버전 관리에 포함시키기
.env파일을 프로젝트 루트 디렉토리에 추가합니다..gitignore파일에.env를 추가하여.env파일이 버전 관리에 포함되지 않도록 설정합니다.
.env
- 프로젝트의
.env파일을 .env.example 파일로 복사합니다.
cp .env .env.example
.env.example 파일에는 실제 값을 포함하지 않고 키만 포함합니다. 이로써 .env.example 파일은 개발자들에게 필요한 키의 목록을 제공합니다.
.env의 각 키-값 쌍을 실제 값으로 채워 넣습니다.
프로젝트에서 환경 변수 로드하기
프로젝트에서 환경 변수를 로드하는 가장 일반적인 방법은 python-dotenv 라이브러리를 사용하는 것입니다.
이 라이브러리를 사용하기 위해, 아래와 같이 설치해야 합니다.
pip install python-dotenv
아래 예시 코드는 .env 파일의 키-값을 환경 변수로 로드하는 방법을 보여줍니다.
import dotenv
dotenv.load_dotenv()
# 환경 변수 사용 예시
DB_URL = os.getenv("DB_URL")
API_KEY = os.getenv("API_KEY")
결론
.env 파일은 개발 환경을 유지하고, 설정 값들을 관리하는 데 중요합니다. 버전 관리 시스템을 통해 .env 파일을 관리함으로써, 프로젝트의 일관성과 유지보수성을 향상시킬 수 있습니다.