파이썬 OpenAI API key 숨기기: env파일, 환경변수 설정

최근 ChatGPT와 같은 AI기술의 등장으로 일반 대중도 자신의 전문 분야에 API를 활용하여 맞춤형 서비스를 만들거나 업무 보조 도구로 사용하는 경우가 늘고 있습니다. OpenAI와 연계한 외부 API 활용은 개인과 기업에 많은 이점을 제공하지만, 동시에 API key가 외부에 노출될 경우 비용 발생이나 데이터 유출 등의 문제를 겪을 수 있습니다. 앞으로 API key의 안전한 관리의 중요성은 더욱 커지고 있다고 볼 수 있습니다. 본 글에서는 파이썬 언어 작성 중 OpenAI API key를 안전하고 효율적으로 사용하는 방법을 정리해봤습니다. 파이썬 프로그램에는 visual studio code, Pycham 등 다양한데요. 제가 지금 공부하고 있는 파이참을 중심으로 설명드리겠습니다.

 

 

파이참 코드 작성시 API 키 숨기는 방법

파이참(PyCharm)은 파이썬 개발에 널리 사용되는 IDE입니다. 장점은 파이썬의 가상 환경을 쉽게 생성하고 관리할 수 있도록 지원하며, 코드를 작성할 때 변수, 함수 등을 자동으로 완성해주는 기능을 제공합니다. 파이참에서는 아래 2가지 방법을 통해 코드 내에 직접 OpenAI API key를 입력하지 않고도 실행시킬 수 있어 작업 효율을 높이고 외부 노출을 방지할 수 있습니다.

 

 

1. dontenv 라이브러리를 활용하여 '.env파일'에 저장하는 방법

env 파일은 환경변수를 저장하는 데 사용되며 애플리케이션 실행 시 필요한 구성 값을 안전하게 관리할 수 있도록 도와주는 역할을 합니다. env란 "environment"의 약자입니다. env파일에 API 키를 저장하여 사용하는 방법은 보편적으로 활용되고 있습니다.

 

• 먼저 프로젝트에 python-dotenv 라이브러리를 설치해야 합니다. PyCharm의 터미널을 열고 다음 명령어를 입력합니다.

pip install python-dotenv

 

프로젝트의 루트 디렉토리에 .env 파일을 생성하고, 여기에 API 키를 다음과 같이 추가합니다. 참고로 루트 디렉토리(root directory)는 파일 시스템의 가장 상위에 위치한 디렉토리(폴더)를 의미합니다.

 

• 생성된 env파일은 project 폴더 안에서 확인해볼 수 있습니다. 
• 파이참으로 돌아와서 env파일에 OpenAI API key를 다음과 같이 추가합니다.

OPENAI_API_KEY=실제 받은 api-key (sk-~!@!#$@$@!!!@#)

 

• 입력이 완료되었다면, dotenv 라이브러리를 사용하여 .env 파일의 내용을 로드하고, 환경 변수로부터 API 키를 읽어올 수 있습니다.
• 다음의 예시 코드 입력을 통해 입력한 API값이 잘 출력되는지 확인할 수 있습니다.

from dotenv import load_dotenv
import os

# .env 파일 로드
load_dotenv()

# 환경 변수에서 API 키 읽기
openai_api_key = os.getenv('OPENAI_API_KEY')

print(openai_api_key)

 

2. 파이참 환경변수 설정하는 방법

이 방법을 사용하면 별도의 env 파일 추가 없이도 파이참(PyCharm) 내에서 직접 OpenAI API key와 같은 환경 변수를 설정할 수 있어 간편합니다.

 

• Run/Debug Configurations 창 열기: PyCharm의 상단 메뉴에서 `Run`을 선택한 후 `Edit Configurations...`를 클릭합니다.

 

• 환경 변수 설정: 실행하려는 스크립트를 선택하고, `Environment variables` 필드를 찾습니다. 이 필드 옆의 `...` 버튼을 클릭하여 환경 변수 편집기를 엽니다.

 

• API 키 추가: 환경 변수 편집기에서 `+` 버튼을 클릭하여 새 환경 변수를 추가합니다. 이름은 `OPENAI_API_KEY`로 하고, 값 필드에 실제 OpenAI API 키를 입력합니다.
• 설정완료: `OK`를 클릭하여 환경 변수 편집기를 닫고, Run/Debug Configurations 창도 'OK'를 클릭하여 닫습니다.
• 다음의 예시 코드를 통해 입력한 API 키가 잘 출력되는지 확인할 수 있습니다.

import os

# 환경 변수에서 API 키 읽기
openai_api_key = os.getenv('OPENAI_API_KEY')

print(openai_api_key)

 

• 이제 설정한 환경 변수는 PyCharm에서 해당 스크립트나 애플리케이션을 실행할 때마다 사용됩니다. 이 방법을 사용하면 파이참 코드 내에 API 키를 직접 쓰지 않아도 되므로 외부로 공유하기가 더 편리합니다.

 

 

 

정리

API 키를 안전하게 관리하는 것은 어떠한 개발 프로젝트에서도 중요합니다. 최근의 기술 발전과 함께 API의 활용도가 높아지는 반면 이러한 보안 관리의 중요성은 간과되기 쉽습니다. 특히, OpenAI API와 같은 AI 서비스들의 등장으로 일반인들도 쉽게 ChatGPT를 통해 코딩할 수 있게 되었습니다. 이로 인해 API 활용의 폭이 넓어지고 있으며, 앞으로 이러한 추세는 더욱 가속화될 것입니다. 오늘은 파이참에서 OpenAI API Key 숨기기에 대한 방법을 알아봤습니다. env 파일 사용한 방법이나 환경변수를 설정하는 방법이 코딩 작업에 도움이 되셨으면 좋겠습니다.