Skip to content

Conversation

@visualmoney
Copy link

🛠️ PR Summary

🌟 요약

어떤 것이 변경되었나요? 간략히 설명해주세요.

인증 토큰을 자동으로 관리하는 기능을 추가했습니다.

📊 주요 변경 사항

주요 변경 사항을 적어주세요.

  • utils.workspace.py 파일을 추가했습니다.
    PyKis 라이브러리의 개인 작업 공간을 관리하는 기능을 추가했습니다.
  • kis.py에서 PyKis 메인 클래스 생성자에 keep_token 인자를 추가했습니다.
    keep_token이 True이면 인증 토큰을 개인 작업 공간에서 자동으로 관리합니다.
  • 웹소켓 Ping을 로깅하는 코드를 제거했습니다.

🎯 목적 및 영향

  • 목적: 왜 이 PR이 필요한가요?
    인증 토큰을 자동으로 관리하는 기능을 추가하여 라이브러리를 손쉽게 사용할 수 있도록 합니다.

  • 영향: 이 변경 사항이 어떤 영향을 미치나요?
    토큰 로드 및 저장을 자동으로 처리하므로 비전문 사용자가 토큰을 관리하는 부담이 줄어듭니다.

…래스가 정상 동작하는지 확인 3. 지 않은 서브클래스는 여전히 추상으로 취급되는지 확인)
…etion

- Add CLAUDE.md: AI development guide with documentation structure
- Add dev_logs/2025-12-18_phase1_week1_complete.md: detailed development log
- Add prompts/2025-12-18_public_api_refactor.md: prompt tracking
- Add reports/2025-12-18_phase1_week1_complete_report.md: completion report
- Update ARCHITECTURE_REPORT_V3_KR.md: mark Week 1 as complete

Establishes documentation workflow:
- prompts/ - user request tracking
- dev_logs/ - daily development logs
- reports/ - phase completion reports
- guidelines/ - coding standards (planned)

Week 1 achievements:
- Public API reduced from 154 to ~15 items
- Type separation system implemented
- Backward compatibility maintained
- 831 tests passing, 93% coverage
- Add four basic examples (quote, balance, place order with safety, realtime price) and README in examples/01_basic
- Enhance QUICKSTART.md with next steps, troubleshooting, FAQ
- Link QUICKSTART and examples from README

Phase 1 Week 2 kickoff: example set prepared with safety guard for live trades
- Update examples to use KisAuth with virtual flag from config.yaml
- Enhance examples/01_basic/README with detailed setup instructions
- config.yaml template should contain actual credentials to run examples
- hello_world.py verified and working
…e architecture report

- Created 05 intermediate examples (01_multiple_symbols, 02_conditional_trading, 03_portfolio_analysis, 04_monitoring_dashboard, 05_advanced_order_types)
- Created 03 advanced examples (01_scope_api_trading, 02_performance_analysis, 03_error_handling)
- Added SIMPLEKIS_GUIDE.md with complete beginner guide
- Updated ARCHITECTURE_REPORT_V3_KR.md with Week 1-4 completion status
- Added comprehensive README files for examples folder
- SimpleKIS docs include create_client, save_config_interactive, and helper functions
- All 832 tests passing, 92% code coverage maintained
- Week 4: 중급/고급 예제 8개 작성 완료 (6.5시간)
- Phase 1 완료: 공개 API 정리(15420), 예제 13개, 테스트 832개
- Phase 2 상세 계획: 문서화 완성, CI/CD 파이프라인 구축
- Phase 3 상세 계획: 커뮤니티 확장, 튜토리얼 및 영문 문서
- Phase 4 계획: 글로벌 문서, 성능 최적화, 신규 시장 지원
- pykis/types.py 문서 업데이트: 130+ 라인 모듈 문서 추가
- 보고서 구조 정리: 4.3~4.9 섹션 명확화
…ANTUML_SETUP.md with run/verify instructions
…event Korean text garbling in installer script
…options; chore(project): update pyproject metadata
- Add public type separation policy to ARCHITECTURE.md
- Create comprehensive CONTRIBUTING.md guide
- Implement API reference auto-generation script
- Create v2.2.0 -> v3.0.0 MIGRATION_GUIDE.md
- Add unit tests for multi-profile config loading
- Update ARCHITECTURE_REPORT with Phase 2 progress

Phase 2 Week 1-2 completed (16 hours)
Next: CI/CD pipeline and expanded integration tests
docs: add dynamic versioning guide and report updates
chore(dev): add pre-commit, ruff, pytest-benchmark

- .github/workflows/ci.yml
- .pre-commit-config.yaml
- docs/developer/VERSIONING.md
- tests/integration + tests/performance samples
- pyproject: dev deps updates
- report: Week 3-4 kickoff
…ive review report with implementation checklists
- CI/CD: OS 매트릭스 확장 (3OS  2Python 버전)
- 커버리지: fail_under=90 정책 추가
- pre-commit: 8개 훅 설정/최신화
- 테스트: 통합/성능 테스트 14개 추가
- 설정: .coveragerc, ci.yml, publish.yml 업데이트
- 아키텍처: ARCHITECTURE_REPORT_V3_KR.md 완료 항목 표시
- 예외 클래스: 3개  13개 확대 (KisConnectionError, KisAuthenticationError, KisRateLimitError, KisServerError, KisTimeoutError 등)
- Retry 메커니즘: exponential backoff + jitter (sync/async 모두 지원)
- JSON 로깅: JsonFormatter 클래스 추가 (ELK/Datadog 호환)
- 로그 레벨 계층화: DEBUG/INFO/WARNING/ERROR (색상 구분)
- 테스트: 31개 추가 (exceptions 17 + logging 14)
- 코드: ~500줄 신규 추가
- 아키텍처 문서: Phase 3 Week 1-2 완성 마크 추가
- FAQ: 23개 Q&A (설치, 인증, 시세, 주문, 계좌, 에러처리, 고급사용법)
- NEWSLETTER_TEMPLATE: 월간 뉴스레터 템플릿
- CONTRIBUTING: FAQ 6-8번 추가 (재시도, JSON 로깅, 예외 처리)
- Jupyter Notebook: 초급 튜토리얼 (11개 섹션)
  - 시세 조회, 주문 실행, 에러 처리, 자동 재시도
  - 실습용 코드 (주석 처리)

문서 추가: 3개
코드 라인: ~700줄
예상 공수: 4-5시간
- MULTILINGUAL_SUPPORT.md: 다국어 지원 전략 (650줄)
   문서 구조 (docs/user/{ko,en}/)
   번역 규칙 및 용어사전
   번역 프로세스 & 품질 기준
   자동 번역 CI/CD 계획
   번역자 커뮤니티 시스템

- REGIONAL_GUIDES.md: 지역별 설정 가이드 (800줄)
   한국: 실제거래, 테스트 환경
   글로벌: Mock 환경, 개발자 가이드
   거래 시간 관리 (시간대, 휴장일)
   지역별 특수 설정

- API_STABILITY_POLICY.md: API 안정성 정책 (650줄)
   API 안정성 레벨 정의 (Stable/Beta/Deprecated/Removed)
   Semantic Versioning 정책
   Breaking Change 마이그레이션 (3단계, 6개월 유예)
   버전별 지원 기간 (12개월)
   호환성 보장 범위

- 영문 공식 문서 (1,250줄)
   README.md: 프로젝트 개요 & Quick start (400줄)
   QUICKSTART.md: 5분 안내서 (350줄)
   FAQ.md: 23개 Q&A 영문 번역 (500줄)

- 개발 문서
   2025-12-20_phase4_global_expansion_prompt.md
   2025-12-20_phase4_week1_global_docs_devlog.md
   PHASE4_WEEK1_COMPLETION_REPORT.md

문서 추가: 7개 (신규)
코드 라인: ~3,500줄
예제 코드: 58개
실소요 시간: 6시간 (예정: 14-16시간)
효율성: 166% (조기완료 40%)
…checklist

- Mark Phase 2 Week 3-4 as completed (CI/CD, pre-commit, integration tests)
- Add detailed Phase 1 implementation checklist with time estimates
- Add current status (progress: ~15%, Phase 1 awaiting)
- Add work priority breakdown (immediate, parallel, next steps)
- Add final summary section with success criteria and completion checklist
- Update version to V3.1 (2025-12-20 update)
- Mark Phase 1 as completed (public_types.py, __init__.py refactoring)
- Update test status: 874 passed, 19 skipped
- Coverage verification: 89.7% (target 90%, -0.3%)
- Fix test___env__.py: Replace VERSION with __version__
- Fix test_exceptions.py: Use proper Mock response attributes
- Add improvement recommendations and priorities
- Update TODO checklist with detailed coverage improvement plan
- Version: V3.2 (2025-12-20 verification complete)
- 아키텍처 문서 7개 모듈식 파일로 재구성 (2,500줄)
  * ARCHITECTURE_README_KR.md: 네비게이션 및 인덱스
  * ARCHITECTURE_CURRENT_KR.md: 현황 분석 및 상태
  * ARCHITECTURE_DESIGN_KR.md: 설계 패턴 및 아키텍처
  * ARCHITECTURE_QUALITY_KR.md: 코드 품질 및 테스트 분석
  * ARCHITECTURE_ISSUES_KR.md: 이슈 추적 (해결/진행/예정)
  * ARCHITECTURE_ROADMAP_KR.md: 실행 계획 및 일정
  * ARCHITECTURE_EVOLUTION_KR.md: v3.0.0 진화 및 마이그레이션

- GitHub Discussions 구축
  * question.yml, feature-request.yml, general.yml 템플릿
  * GITHUB_DISCUSSIONS_SETUP.md 설정 가이드

- Phase 4 글로벌 확장 완료
  * 영문 문서 3개 (README, QUICKSTART, FAQ)
  * 가이드라인 5개 (3,500줄)
  * 튜토리얼 영상 스크립트 (600줄)

- 이전 단일 문서 아카이브 (V1/V2/V3)

메트릭: 총 5,650줄 신규 문서 작성
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant