Skip to content

Commit db6fac3

Browse files
committed
docs: add required environment variables section for KRX API login
1 parent 5b2a2d6 commit db6fac3

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,33 @@ pytest -v
6060
- 모든 설정은 `pyproject.toml`에서 관리됩니다
6161
- VS Code 사용 시: `ruff` 익스텐션 설치하면 저장 시 자동 포맷 적용
6262

63+
### 1.3 환경변수 설정 (Required Environment Variables)
64+
65+
KRX 로그인이 필요한 API를 사용하려면 아래 두 환경변수를 **반드시** 설정해야 합니다.
66+
67+
| 변수명 | 필수 여부 | 설명 |
68+
|--------|-----------|------|
69+
| `KRX_ID` | **필수** | KRX(한국거래소) 회원 로그인 ID |
70+
| `KRX_PW` | **필수** | KRX(한국거래소) 회원 로그인 비밀번호 |
71+
72+
환경변수가 설정되지 않으면 KRX 로그인이 실패하고 인증이 필요한 데이터를 조회할 수 없습니다.
73+
74+
```bash
75+
# macOS / Linux
76+
export KRX_ID="your_krx_id"
77+
export KRX_PW="your_krx_password"
78+
79+
# Windows (PowerShell)
80+
$env:KRX_ID="your_krx_id"
81+
$env:KRX_PW="your_krx_password"
82+
83+
# Windows (Command Prompt)
84+
set KRX_ID=your_krx_id
85+
set KRX_PW=your_krx_password
86+
```
87+
88+
> **참고:** `.env` 파일을 사용하는 경우 `python-dotenv` 등을 활용해 로드하세요. `.env` 파일은 절대 버전 관리(git)에 포함하지 마세요.
89+
6390
### 지원 Python 버전
6491

6592
이 프로젝트는 다음 Python 버전을 지원합니다:

0 commit comments

Comments
 (0)