최초 프로젝트 업로드 (Script Auto Commit)

This commit is contained in:
2025-12-03 22:37:46 +09:00
commit ed7084dd8f
30 changed files with 3254 additions and 0 deletions

354
docs/DEPLOYMENT.md Normal file
View File

@@ -0,0 +1,354 @@
# 자동매매 활성화 가이드 (Deployment & Safety)
## 개요
이 문서는 MACD 알림 봇의 **자동매매 기능(auto_trade)**을 안전하게 활성화하고 운영하는 방법을 설명합니다.
---
## 1. 사전 준비 (필수)
### 1.1 Upbit API 키 생성
1. [Upbit 홈페이지](https://upbit.com) 로그인
2. 계정 설정 → API 관리 → "Open API" 클릭
3. "오픈 API 키 생성" 버튼 클릭
4. 접근 권한:
-**조회**: 계좌, 자산, 주문내역 (필수)
-**매매**: 매도 주문 (필수)
-**출금**: 해제 권장 (자동매매에 불필요)
5. IP 화이트리스트: 봇이 실행되는 서버 IP 추가 (선택, 권장)
6. Access Key / Secret Key 메모 (비밀 유지!)
### 1.2 Telegram Bot 토큰 & Chat ID 확인
- 기존에 설정했다면 그대로 사용 가능
- 없다면 [BotFather로 새 봇 생성](https://core.telegram.org/bots#botfather) 후 Chat ID 확인
### 1.3 환경변수 설정 (`.env` 파일)
```bash
# Telegram 알림
TELEGRAM_BOT_TOKEN=your_bot_token
TELEGRAM_CHAT_ID=your_chat_id
# Upbit API (자동매매 시 필수)
UPBIT_ACCESS_KEY=your_access_key
UPBIT_SECRET_KEY=your_secret_key
# 선택: 자동매매 활성화 확인 (require_env_confirm=true일 때)
AUTO_TRADE_ENABLED=1
# 선택: 주문 모니터링 타임아웃 (초, 기본 120)
ORDER_MONITOR_TIMEOUT=120
# 선택: 주문 폴링 간격 (초, 기본 3)
ORDER_POLL_INTERVAL=3
# 선택: 재시도 횟수 (기본 1)
ORDER_MAX_RETRIES=1
```
⚠️ `.env` 파일을 `.gitignore`에 추가하여 비밀 정보를 저장소에 커밋하지 마세요.
---
## 2. config.json 설정
### 2.1 기본 설정 (신중하게)
```json
{
"trading_mode": "signal_only",
"auto_trade": {
"enabled": false,
"max_trade_krw": 1000000,
"allowed_symbols": [],
"require_env_confirm": true
},
"confirm": {
"confirm_via_file": true,
"confirm_timeout": 300
},
"monitor": {
"enabled": true,
"timeout": 120,
"poll_interval": 3,
"max_retries": 1
},
"notify": {
"order_filled": true,
"order_partial": true,
"order_cancelled": true,
"order_error": true
},
"dry_run": true
}
```
### 2.2 각 항목 설명
#### `trading_mode`
- `"signal_only"` (기본): Telegram 알림만 전송
- `"auto_trade"`: 자동매매 시도 (수동 확인 필수)
- `"mixed"`: 알림 + 거래 기록
#### `auto_trade`
- `enabled`: `false`로 유지 (기본값). 실제 자동매도 활성화하려면 명시적으로 `true`로 변경
- `buy_enabled`: `false`로 유지 (기본값). 실제 자동매수 활성화하려면 명시적으로 `true`로 변경
- `buy_amount_krw`: 매수 시 사용할 KRW 금액 (예: 10,000)
- `max_trade_krw`: 한 번에 매도할 최대 KRW 금액 (예: 1,000,000)
- `allowed_symbols`: 자동매매 허용 심볼 목록. 빈 배열이면 모든 심볼 허용
- 예: `["KRW-BTC", "KRW-ETH"]` (이 심볼들만 자동매매)
- `require_env_confirm`: `true`이면 환경변수 `AUTO_TRADE_ENABLED=1` 필요 (권장)
#### `confirm`
- `confirm_via_file`: 파일 기반 확인 활성화 여부
- `confirm_timeout`: 확인 대기 시간(초). 이 시간 내에 확인이 없으면 주문 취소
#### `monitor`
- `enabled`: 주문 모니터링 활성화
- `timeout`: 주문 폴링 타임아웃(초)
- `poll_interval`: 주문 상태 확인 간격(초)
- `max_retries`: 타임아웃 시 재시도 횟수
#### `notify`
- `order_filled`: 완전체결 시 알림
- `order_partial`: 부분체결/타임아웃 시 알림
- `order_cancelled`: 주문 취소 시 알림
- `order_error`: 오류 발생 시 알림
---
## 3. 안전 체크리스트 (자동매매 활성화 전)
### ✅ 필수 확인 항목
- [ ] Upbit API 키가 올바르게 발급되었나? (테스트 계좌에서 실제 키 사용하기)
- [ ] `.env` 파일이 `.gitignore`에 있나?
- [ ] `config.json``dry_run``true`로 설정되어 있나? (테스트 단계)
- [ ] `auto_trade.enabled``false`로 설정되어 있나? (테스트 단계)
- [ ] 로그 파일(`logs/macd_alarm.log`)을 확인할 수 있는 환경인가?
### ✅ 단계적 활성화 (점진적 위험 증가)
#### 3.1 단계 1: Signal-Only 모드 (알림만)
```json
{
"trading_mode": "signal_only",
"dry_run": true
}
```
- 실행: `python main.py`
- 기대 결과: 매도/매수 신호 감지 시 Telegram 알림 수신
- 확인: 로그에 오류 없고, Telegram 메시지가 제대로 도착하는가?
#### 3.2 단계 2: Mixed 모드 (알림 + 기록, dry-run)
```json
{
"trading_mode": "mixed",
"auto_trade": {
"enabled": false,
"buy_enabled": false
},
"dry_run": true
}
```
- 실행: `python main.py`
- 기대 결과: 매도 신호 시 Telegram + `trades.json` 기록
- 매수 신호는 `auto_trade.buy_enabled`가 true일 때만 `trades.json`에 기록됨
- 확인: `trades.json`에 매도 기록이 제대로 저장되는가? (매수 기록은 buy_enabled가 true일 때만 저장됨)
#### 3.3 단계 3: Auto-Trade 시뮬레이션 (dry-run, 실제 주문 아님)
```json
{
"trading_mode": "auto_trade",
"auto_trade": {
"enabled": true,
"max_trade_krw": 100000,
"allowed_symbols": [],
"require_env_confirm": true
},
"dry_run": true
}
```
- 환경변수 설정:
```bash
$env:AUTO_TRADE_ENABLED = "1"
```
- 실행: `python main.py`
- 기대 결과:
- 매도 신호 감지 시 Telegram으로 확인 토큰 수신
- 토큰으로 파일 생성 후 주문 진행 (시뮬레이션)
- `pending_orders.json` 및 `trades.json`에 기록
- 확인:
- Telegram 확인 메시지 형식이 명확한가?
- 파일 생성으로 확인 메커니즘이 동작하는가?
- 거래 기록이 제대로 저장되는가?
#### 3.4 단계 4: **실제 자동매도 활성화** (최종 단계, 신중!)
```json
{
"trading_mode": "auto_trade",
"auto_trade": {
"enabled": true,
"buy_enabled": false,
"max_trade_krw": 100000,
"allowed_symbols": ["KRW-BTC"],
"require_env_confirm": true
},
"dry_run": false
}
```
- 환경변수 설정:
```bash
$env:AUTO_TRADE_ENABLED = "1"
```
- Upbit 테스트 계좌 또는 소액 계좌 사용 권장
- 실행: `python main.py`
- 확인:
- Telegram에서 실제 매도 주문 확인 메시지 수신
- 파일 생성으로 주문 실행
- Upbit 계정에서 주문 이력 확인
- 모니터링 후 체결 알림 수신
#### 3.5 단계 5: **실제 자동매수 활성화** (최종 단계, 매우 신중!)
```json
{
"trading_mode": "auto_trade",
"auto_trade": {
"enabled": true,
"buy_enabled": true,
"buy_amount_krw": 10000,
"max_trade_krw": 100000,
"allowed_symbols": ["KRW-BTC"],
"require_env_confirm": true
},
"dry_run": false
}
```
- 환경변수 설정:
```bash
$env:AUTO_TRADE_ENABLED = "1"
```
- ⚠️ **중요**: 자동매수는 자본 손실 위험이 높습니다. 반드시 소액으로 시작하세요.
- Upbit 테스트 계좌 또는 소액 계좌 사용 필수
- 실행: `python main.py`
- 확인:
- 매수 신호 감지 시 Telegram에서 매수 주문 확인 메시지 수신
- 파일 생성으로 주문 실행
- Upbit 계정에서 매수 주문 이력 확인
- 모니터링 후 체결 알림 수신
- `holdings.json`에 새로운 보유 정보 자동 기록
---
## 4. 주문 확인 프로세스
### 4.1 Telegram 기반 확인 (현재 구현)
1. 자동매매 신호 감지 → Telegram 알림 수신
```
[확인필요] 자동매매 주문 대기
토큰: a1b2c3d4
심볼: KRW-BTC
주문량: 0.00010000
```
2. 프로젝트 루트에서 파일 생성 (PowerShell 예):
```powershell
New-Item "confirm_a1b2c3d4" -ItemType File
```
또는 `confirmed_tokens.txt` 파일에 토큰 추가:
```
a1b2c3d4
```
3. 코드가 자동으로 파일/토큰 감지 → 주문 실행
### 4.2 타임아웃
- 기본 300초(5분) 내에 확인이 없으면 자동 취소
- `config.json`의 `confirm.confirm_timeout`으로 조정 가능
---
## 5. 운영 (Troubleshooting)
### 주문이 실행되지 않는 경우
1. **환경변수 확인**:
```bash
echo $env:AUTO_TRADE_ENABLED
# 결과: 1이어야 함
```
2. **API 키 확인**:
```bash
echo $env:UPBIT_ACCESS_KEY
# 결과: 실제 키가 설정되어 있어야 함
```
3. **로그 파일 확인**:
```bash
Get-Content "logs/macd_alarm.log" -Tail 20
# "자동매매 비활성화" 또는 "Upbit API 키 없음" 오류 찾기
```
4. **config.json 문법 확인**:
```bash
python -c "import json; json.load(open('config.json'))"
# JSON 파싱 오류 있으면 출력됨
```
### 부분체결 처리
- 주문량이 크거나 시장 유동성이 낮으면 부분체결 발생 가능
- `ORDER_MAX_RETRIES` 환경변수로 재시도 횟수 조정 (기본 1회)
- 모니터링은 `ORDER_MONITOR_TIMEOUT` 시간(기본 120초) 동안 진행
### 긴급 중지
- 파일 생성하지 않으면 `confirm_timeout` 후 자동 취소
- 또는 `dry_run: true`로 되돌려서 봇 재시작
---
## 6. 성능/안정성 팁
1. **작은 규모로 시작**:
- `max_trade_krw`: 처음엔 10만~100만 KRW 범위
- `allowed_symbols`: 확실한 심볼 몇 개만 선택
2. **로그 모니터링**:
- 실시간: `Get-Content "logs/macd_alarm.log" -Tail 10 -Wait`
- 또는 별도 터미널에서: `tail -f logs/macd_alarm.log`
3. **야간/주말 고려**:
- Upbit는 24/7 운영이지만, 유동성이 낮은 시간대 존재
- 백테스트 후 적절한 시간대에만 매매 권장
4. **백업**:
- `trades.json` 주기적 백업
- 또는 SQLite로 마이그레이션 고려
---
## 7. FAQ
**Q: 실제로 주문이 체결되면 어떻게 되나?**
A: Upbit 계정에서 직접 체결되며, `trades.json` + Telegram 알림으로 기록됩니다.
**Q: 파일 생성을 깜빡하면?**
A: `confirm_timeout` 후 자동 취소되고, `trades.json`에 `user_not_confirmed` 기록됩니다.
**Q: 여러 심볼이 동시에 신호 나면?**
A: 각 심볼마다 독립적인 토큰으로 확인 요청. 병렬 처리 가능.
**Q: 테스트 중 실제 주문을 방지하려면?**
A: `dry_run: true` 또는 `auto_trade.enabled: false`, `auto_trade.buy_enabled: false` 유지.
**Q: 자동매수와 자동매도를 독립적으로 제어할 수 있나?**
A: 네. `auto_trade.enabled`는 매도만, `auto_trade.buy_enabled`는 매수만 제어합니다. 각각 독립적으로 활성화/비활성화 가능합니다.
**Q: 매수 후 holdings.json은 자동으로 업데이트되나?**
A: 네. 매수 체결 완료 시 자동으로 `holdings.json`에 매수가, 수량, 최고가, 매수시간이 기록됩니다.
**Q: 자동매수 금액을 어떻게 설정하나?**
A: `config.json`의 `auto_trade.buy_amount_krw`에 매수할 KRW 금액을 설정하세요. (예: 10000 = 1만원)
---
## 8. 법적 공지
⚠️ **면책**: 이 봇은 교육 목적으로 제작되었습니다. 실제 투자/자동매매 시 발생하는 손실에 대해 개발자는 책임을 지지 않습니다. 충분한 테스트 후 자신의 책임 하에 사용하세요.

33
docs/PRD.md Normal file
View File

@@ -0,0 +1,33 @@
<!-- 기획 및 로직 설계서 -->
<!-- PRD.md -->
# Product Requirements Document (PRD)
## 1. Project Overview
- **프로젝트명:** (예: Stock-Finder-AI)
- **목적:** (예: 미국/한국 주식 시장에서 특정 조건에 맞는 종목을 필터링하고, 매수/매도 신호를 포착하여 알림을 보낸다.)
- **주요 사용자:** 퀀트 투자자, 개인 트레이더
## 2. Core Features (User Stories)
1. **데이터 수집:** 야후 파이낸스 API 및 한국투자증권 API를 통해 일봉/분봉 데이터를 수집한다.
2. **지표 계산:** 수집된 데이터로 RSI, Bollinger Bands, MACD를 계산한다.
3. **필터링 로직:** PBR < 1.0 이면서 RSI < 30인 종목을 추출한다.
4. **알림 발송:** 추출된 종목을 텔레그램 봇으로 전송한다.
## 3. Data Flow & Architecture
- **Input:** 종목 리스트 (Ticker List), 설정된 파라미터 (config.json)
- **Process:**
1. Data Fetcher -> (Raw Data) -> DB 저장
2. Indicator Engine -> (Calculated Data)
3. Screener -> (Filtered List)
- **Output:** JSON 리포트 및 메신저 알림
## 4. File Structure Plan
- /src/data_loader.py : API 연동 및 데이터 수집
- /src/indicators.py : 기술적 지표 계산 로직
- /src/screener.py : 필터링 및 종목 선정 핵심 로직
- /src/notifier.py : 메시지 발송 처리
## 5. Non-Functional Requirements
- **성능:** 2000개 종목 스캔을 3분 이내 완료할 것 (멀티스레딩/비동기 필수).
- **안정성:** API 호출 제한(Rate Limit) 도달 시 자동으로 Backoff/Retry 수행.

View File

@@ -0,0 +1,30 @@
<!-- 단계별 구현 체크리스트 -->
<!-- implementation_plan.md -->
# Implementation Plan
이 문서는 개발 진행 상황을 추적합니다. AI는 이 문서를 참조하여 현재 단계의 작업을 수행해야 합니다.
## Phase 1: 환경 설정 및 기본 구조 [ ]
- [ ] 프로젝트 폴더 구조 생성 및 Git 초기화
- [ ] `copilot-instructions.md``.env` 템플릿 작성
- [ ] Python 가상환경 설정 및 `requirements.txt` 작성 (pandas, numpy, requests 등)
## Phase 2: 데이터 수집 모듈 (Data Fetcher) [ ]
- [ ] `data_loader.py`: 외부 API 연동 클래스 작성
- [ ] API Rate Limit 처리 로직 (Retry/Backoff) 구현
- [ ] 단위 테스트: API 연결 및 데이터 수신 확인
## Phase 3: 핵심 로직 구현 (Core Logic) [ ]
- [ ] `indicators.py`: RSI, MACD 계산 함수 구현
- [ ] `screener.py`: 조건식 필터링 엔진 구현
- [ ] 단위 테스트: 샘플 데이터를 이용한 지표 계산 정확도 검증
## Phase 4: 알림 및 메인 실행 (Interface) [ ]
- [ ] `notifier.py`: 텔레그램/슬랙 메시지 발송 함수
- [ ] `main.py`: 전체 프로세스(수집->계산->필터->알림) 통합 실행
- [ ] 통합 테스트 (Integration Test)
## Phase 5: 최적화 및 리팩토링 [ ]
- [ ] 비동기(asyncio) 적용으로 속도 개선
- [ ] 코드 리뷰 프롬프트(`review_prompt.md`) 기반 자가 점검 수행

88
docs/review_prompt.md Normal file
View File

@@ -0,0 +1,88 @@
<!-- AI 코드 리뷰 지침 -->
<!-- review_prompt.md -->
<!-- -->
<!-- 코드 리뷰 프롬프트(실무용, 핵심 위주) -->
<!-- -->
<!-- [1. 분석 컨텍스트] -->
<!-- 언어/환경: (예: Python 3.11, AWS Lambda) -->
<!-- 코드 목적: (예: 결제 로직 처리) -->
<!-- 핵심 요구: (예: 동시성 문제 해결, 성능 최적화) -->
<!-- -->
<!-- [2. 역할 및 원칙] -->
<!-- 당신은 가장 까다로운 시니어 개발자입니다. 칭찬은 생략하고, 오직 **결함(Bug)**과 **위험 요소(Risk)**만 찾아내십시오. -->
<!-- - 원칙: 코드가 "문제없다"고 가정하지 마십시오. 숨겨진 논리적 오류, 예외 처리 누락, 보안 취약점을 집요하게 파고드십시오. -->
<!-- - 금지: 코드에 없는 내용을 추측하여 지적하지 마십시오(No Hallucination). -->
<!-- -->
<!-- [3. 중점 검토 항목] -->
<!-- 1. 논리 오류: 엣지 케이스(Null, 0, 경계값)에서 로직이 깨지지 않는가? -->
<!-- 2. 안정성: 예외가 발생했을 때 시스템이 안전하게 복구되거나 종료되는가? (Silent Failure 방지) -->
<!-- 3. 보안: SQL 인젝션, XSS, 민감 정보(비번/키) 노출이 있는가? -->
<!-- 4. 효율성: 불필요한 반복문(O(n²))이나 메모리 누수가 있는가? -->
<!-- -->
<!-- [4. 출력 형식] -->
<!-- 발견된 문제가 없다면 "특이사항 없음"이라고 하십시오. 문제가 있다면 아래 양식으로 핵심만 적어주세요. -->
<!-- -->
<!-- 🚨 치명적 문제 (Critical) -->
<!-- - 위치: [라인 번호 또는 코드 스니펫] -->
<!-- - 이유: (왜 위험한지 기술적 설명) -->
<!-- - 해결책: (수정된 코드 블록) -->
<!-- -->
<!-- ⚠️ 개선 제안 (Warning) -->
<!-- - 위치: [라인 번호] -->
<!-- - 내용: (잠재적 위험 또는 가독성/성능 개선 제안) -->
<!-- -->
<!-- 코드 리뷰 프롬프트(심화버전) -->
[1. 분석 컨텍스트]
정확한 분석을 위해 아래 정보를 기반으로 코드를 검토하십시오.
- 언어/프레임워크: (예: Python 3.11, Spring Boot)
- 코드의 목적: (예: 대용량 트래픽 처리, 결제 로직, 데이터 파싱)
- 주요 제약사항: (예: 동시성 처리 필수, 응답속도 중요, 메모리 효율성)
[2. 역할 및 원칙]
당신은 '무관용 원칙'을 가진 수석 소프트웨어 아키텍트입니다.
- 목표: 칭찬보다는 결함(Bug), 보안 취약점, 성능 병목, 유지보수 저해 요소를 찾아내는 데 집중하십시오.
- 금지: 코드에 없는 내용을 추측하여 지적하지 마십시오(Zero Hallucination).
- 기준: "작동한다"에 만족하지 말고, "견고하고 안전한가"를 기준으로 판단하십시오.
[3. 사전 단계: 의도 파악]
분석 전, 이 코드가 수행하는 핵심 로직을 3줄 이내로 요약하여, 당신이 코드를 올바르게 이해했는지 먼저 보여주십시오.
[4. 심층 검토 체크리스트]
다음 항목을 기준으로 코드를 해부하십시오.
1. 논리 및 엣지 케이스 (Logic & Edge Cases)
- 가상 실행: 코드를 한 줄씩 추적하며 변수 상태 변화를 검증했는가?
- 경계값: Null, 빈 값, 음수, 최대값 등 극한의 입력에서 로직이 깨지지 않는가?
- 예외 처리: 에러를 단순히 삼키지 않고(Silent Failure), 적절히 처리하거나 전파하는가?
2. 보안 및 안정성 (Security & Stability)
- 입력 검증: SQL 인젝션, XSS, 버퍼 오버플로우 취약점이 없는가?
- 정보 노출: 비밀번호, API 키, PII(개인정보)가 하드코딩되거나 로그에 남지 않는가?
- 자원 관리: 파일, DB 연결, 메모리 등이 예외 발생 시에도 확실히 해제되는가?
3. 동시성 및 성능 (Concurrency & Performance)
- 동기화: (해당 시) 경쟁 상태(Race Condition), 데드락, 스레드 안전성 문제가 없는가?
- 효율성: 불필요한 중첩 반복문(O(n²)), N+1 쿼리, 중복 연산이 없는가?
[5. 출력 형식: 결함 보고서]
발견된 문제가 없다면 "특이사항 없음"으로 명시하십시오. 문제가 있다면 아래 양식을 엄수해 주세요.
🚨 치명적 문제 (Critical Issues)
(서비스 중단, 데이터 손실/오염, 보안 사고 위험이 있는 경우)
[C-1] 문제 제목
├─ 위치: [파일경로:라인] 또는 [코드 스니펫 3~5줄]
├─ 원인: [기술적 원인 설명]
├─ 재현/조건: [문제가 발생하는 상황]
└─ 해결책: [수정된 코드 블록 (Auto-Fix)]
⚠️ 개선 제안 (Warnings & Improvements)
(성능 저하, 유지보수성 부족, 잠재적 버그)
[W-1] 문제 제목
├─ 위치: [파일경로:라인] 또는 [코드 스니펫]
├─ 분석: [문제점 설명]
└─ 권장 조치: [리팩토링 제안]
✅ 잘된 점 (Strengths)
(핵심적인 장점 1~2가지만 간결하게)

4
docs/sample.md Normal file
View File

@@ -0,0 +1,4 @@
<!-- 사용 방법 (워크플로우) -->
<!-- -->
<!-- rules.md와 PRD.md를 참고해서, implementation_plan.md의 단계로 코드를 작성해줘. -->
<!-- 코드를 review_prompt.md 기준으로 검토해줘. -->