Metadata-Version: 2.1
Name: pyqqq
Version: 0.12.243
Summary: Package for quantitative strategy development on the PyQQQ platform
License: MIT
Author: PyQQQ team
Author-email: pyqqq.cs@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: cachetools (>=5.3.3,<6.0.0)
Requires-Dist: cssutils (>=2.10.2,<3.0.0)
Requires-Dist: diskcache (>=5.6.3,<6.0.0)
Requires-Dist: pandas (>=2.0.3,<3.0.0)
Requires-Dist: pandas-market-calendars (>=4.4.2,<5.0.0)
Requires-Dist: pika (>=1.3.2,<2.0.0)
Requires-Dist: pycryptodome (>=3.20.0,<4.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: tinydb (>=4.8.0,<5.0.0)
Requires-Dist: websockets (>=12.0,<13.0)
Project-URL: Documentation, https://docs.pyqqq.net
Description-Content-Type: text/markdown

# PyQQQ SDK

[![PyPI](https://img.shields.io/pypi/v/pyqqq)](https://pypi.org/project/pyqqq/)
[![Python](https://img.shields.io/pypi/pyversions/pyqqq)](https://pypi.org/project/pyqqq/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**PyQQQ SDK(`pyqqq`)** 는 [PyQQQ](https://www.pyqqq.net) 플랫폼에서 퀀트 전략을 개발하기 위한 Python SDK입니다.
국내 주식·선물옵션 시장 데이터 조회와 증권사(한국투자증권, LS증권) 연동 기능을 제공하며, 데이터 분석부터 자동 매매 전략 운영까지 하나의 SDK로 처리할 수 있습니다.

## 주요 기능

- **시장 데이터 조회** — 국내/미국 주식의 일봉·분봉·틱, 지수, 파생상품 데이터 (`pyqqq.data`)
- **증권사 연동** — 한국투자증권(KIS), LS증권(eBest) OAuth 인증, 시세 조회, 주문/체결 (`pyqqq.brokerage`)
- **실시간 추적** — WebSocket 기반 주문·포지션 이벤트 트래커 (`TradingTracker`)
- **백테스팅** — 과거 데이터 기반 전략 검증 프레임워크 (`pyqqq.backtest`)

## 설치

```bash
pip install pyqqq
```

Python 3.9 이상을 지원합니다. (3.11 이상 권장)

## API Key 설정

시장 데이터 조회에는 PyQQQ API Key가 필요합니다.
[pyqqq.net](https://www.pyqqq.net) 회원가입 후 [프로필 페이지](https://pyqqq.net/profile)에서 발급받을 수 있습니다.

발급받은 키는 다음 중 한 가지 방법으로 설정합니다.

```bash
# 방법 1: ~/.qred 파일에 저장
echo "your-api-key" > ~/.qred

# 방법 2: 환경변수로 설정
export PYQQQ_API_KEY="your-api-key"
```

## 빠른 시작

**일봉(OHLCV) 데이터 조회**

```python
import datetime as dtm
from pyqqq.data.daily import get_ohlcv_by_codes_for_period

codes = ["005930", "000660"]  # 삼성전자, SK하이닉스
ohlcv = get_ohlcv_by_codes_for_period(codes, dtm.date(2025, 1, 6), dtm.date(2025, 1, 10))

for code, df in ohlcv.items():
    print(f"code: {code}")
    print(df)
```

**증권사 API로 시세 조회 (한국투자증권)**

```python
from pyqqq.brokerage.kis.oauth import KISAuth
from pyqqq.brokerage.kis.simple import KISSimpleDomesticStock

auth = KISAuth(app_key="...", app_secret="...")
stock = KISSimpleDomesticStock(auth, account_no="...", account_product_code="01")

price = stock.get_price("005930")  # 삼성전자 현재가
print(price)
```

더 많은 예제는 [튜토리얼 문서](https://docs.pyqqq.net)에서 확인할 수 있습니다.

## 문서

전체 문서는 **[docs.pyqqq.net](https://docs.pyqqq.net)** 에서 제공됩니다.

- [시작하기](https://docs.pyqqq.net) — 설치, API Key 설정, 첫 데이터 조회
- [사용자 가이드](https://docs.pyqqq.net) — 전략 배포, 백테스팅, 자동 거래 훅
- [API 레퍼런스](https://docs.pyqqq.net) — 모든 함수·클래스 상세 문서

## 라이선스

[MIT License](https://opensource.org/licenses/MIT)

