Metadata-Version: 2.1
Name: koapy
Version: 0.3.1
Summary: Kiwoom Open Api Python
Home-page: https://github.com/elbakramer/koapy
Author: Yunseong Hwang
Author-email: kika1492@gmail.com
License: MIT OR Apache-2.0 OR GPL-3.0-or-later
Description: =====
        KOAPY
        =====
        
        
        .. container::
        
            .. image:: https://img.shields.io/pypi/v/koapy.svg
                    :target: https://pypi.python.org/pypi/koapy
                    :alt: PyPI Version
        
            .. image:: https://img.shields.io/pypi/pyversions/koapy.svg
                    :target: https://pypi.python.org/pypi/koapy/
                    :alt: PyPI Python Versions
        
            .. image:: https://img.shields.io/pypi/status/koapy.svg
                    :target: https://pypi.python.org/pypi/koapy/
                    :alt: PyPI Status
        
            .. badges from below are commendted out
        
            .. .. image:: https://img.shields.io/pypi/dm/koapy.svg
                    :target: https://pypi.python.org/pypi/koapy/
                    :alt: PyPI Monthly Donwloads
        
        
        .. container::
        
            .. image:: https://img.shields.io/travis/elbakramer/koapy.svg
                    :target: https://travis-ci.org/elbakramer/koapy
                    :alt: Travis CI Build Status
            .. .. image:: https://travis-ci.org/elbakramer/koapy.svg?branch=master
        
            .. image:: https://img.shields.io/readthedocs/koapy/latest.svg
                    :target: https://koapy.readthedocs.io/en/latest/?badge=latest
                    :alt: ReadTheDocs Documentation Build Status
            .. .. image:: https://readthedocs.org/projects/koapy/badge/?version=latest
        
            .. image:: https://img.shields.io/codecov/c/github/elbakramer/koapy.svg
                    :target: https://codecov.io/gh/elbakramer/koapy
                    :alt: Codecov Coverage
            .. .. image:: https://codecov.io/gh/elbakramer/koapy/branch/master/graph/badge.svg
        
            .. image:: https://img.shields.io/requires/github/elbakramer/koapy/master.svg
                    :target: https://requires.io/github/elbakramer/koapy/requirements/?branch=master
                    :alt: Requires.io Requirements Status
            .. .. image:: https://requires.io/github/elbakramer/koapy/requirements.svg?branch=master
        
            .. badges from below are commendted out
        
            .. .. image:: https://pyup.io/repos/github/elbakramer/koapy/shield.svg
                    :target: https://pyup.io/repos/github/elbakramer/koapy/
                    :alt: PyUp Updates
        
        
        .. container::
        
            .. image:: https://img.shields.io/pypi/l/koapy.svg
                    :target: https://github.com/elbakramer/koapy/blob/master/LICENSE
                    :alt: PyPI License
        
            .. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Felbakramer%2Fkoapy.svg?type=shield
                    :target: https://app.fossa.com/projects/git%2Bgithub.com%2Felbakramer%2Fkoapy?ref=badge_shield
                    :alt: FOSSA Status
        
        
        .. container::
        
            .. image:: https://badges.gitter.im/elbakramer/koapy.svg
                    :target: https://gitter.im/koapy/community
                    :alt: Gitter Chat
            .. .. image:: https://img.shields.io/gitter/room/elbakramer/koapy.svg
        
        
        Kiwoom Open Api Python
        
        
        * Free software: MIT OR Apache-2.0 OR GPL-3.0-or-later
        * Documentation: https://koapy.readthedocs.io.
        
        
        Features
        --------
        
        KOAPY 는 `키움증권의 OpenAPI`_ 를 Python 에서 쉽게 사용할 수 있도록 만든 라이브러리 패키지 및 툴입니다.
        
        키움에서 제공하는 OpenAPI 를 활용하는데 필요한 아래와 같은 지식들을 알지 못해도,
        기본적인 Python 에 대한 지식만 어느 정도 있다면 쉽게 사용할 수 있도록 하는 것에 초점을 두었습니다.
        
        * 키움에서 제공하는 OpenAPI 의 OCX 라이브러리 구조
        * OCX 를 Python 에서 구동하기 위한 PyQt5_/PySide2_ 와 |QAxWidget|_ 생성
        * 컨트롤에서 함수 호출을 위한 |dynamicCall|_ 함수 사용
        * 이벤트 처리를 위해 적절한 |signal|_/|slot|_ 설정 및 처리
        
        KOAPY 는 아래와 같은 기능을 제공합니다.
        
        * PyQt5_/PySide2_ 를 기반한 GUI 환경에 얽매일 필요 없이 일반적인 라이브러리처럼 가져다 활용할 수 있습니다.
          CLI 형태로 쓸 수도 있고 이외에 다양한 곳에서도 쉽게 활용이 가능합니다.
        * 컨트롤 함수 호출 시 명세에 적혀있는 형태 그대로 Python 함수였던 것처럼 호출이 가능합니다.
          이후는 KOAPY 가 유연하게 처리합니다.
          매번 명세에 맞게 |dynamicCall|_ 의 인자를 적어 넣거나, 모든 존재하는 함수에 대해 미리 래퍼 함수를 손 아프게 만들어놓을 필요가 없습니다.
        * 이벤트 처리 및 비동기 프로그래밍에 익숙하지 않더라도 그보다 비교적 쉬운 인터페이스를 통해 관련 기능들을 활용할 수 있습니다.
          가장 간단한 로그인 처리부터 TR/실시간 데이터 처리, 그리고 주문처리까지 다양한 시나리오에 대한 기본 이벤트 처리 로직을 제공합니다.
        * 주식 기본정보 요청부터 일봉/분봉 등 시세 데이터 확인 그리고 예수금/잔고 확인까지 일반적으로 자주 사용되는 기능들에 대해서
          미리 구현된 함수를 제공합니다. 함수 호출 결과 중 테이블성 정보들은 |pandas.DataFrame|_ 타입으로 제공해 이후 분석 및 처리가 유용하게끔 했습니다.
        * TR 의 입력/출력 데이터 구조, 실시간 데이터별 FID 목록, 에러코드에 대한 설명문 등,
          개발하는 과정에서 필요한 여러 메타정보들을 언어 내 라이브러리에서 바로 조회 및 활용이 가능합니다.
          매번 매뉴얼_ 이나 KOAStudio_ 를 열어서 참고하고 이후 일일이 하나씩 하드코딩할 필요가 없습니다.
        * 로컬 네트워크에서 gRPC_ 를 통한 서버-클라이언트 형태의 구성이 가능합니다.
          이를 통해 "라이브러리 호환성으로 인해 32bit 환경에서만 작업되어야 한다" 는 제약을 벗어나 클라이언트는 Python 64bit 를 사용할 수도 있습니다.
          더 나아가서는 gRPC_ 에서 지원하는 모든 다양한 언어를 클라이언트로 작성해 사용하는 방식으로도 확장 가능합니다.
        * 이외에 메시징/알람 기능, 휴장일 확인, TR 호출 시 호출 횟수 제한 회피 등 개발 및 활용에 필요한 다양한 부가기능들을 추가로 제공합니다.
        * 굳이 Python 코드를 작성하지 않더라도 기본적인 기능들을 활용해볼 수 있도록 여러 커맨드를 포함하는 CLI 를 제공합니다.
          CLI 를 활용하면 마켓별 코드 목록 확인, 주식 기본정보 확인, 일봉/분봉 데이터 확인 및 저장, 실시간 데이터 구독 등
          다양한 기능들을 코드 구현 없이 사용할 수 있습니다. 서버도 CLI 커맨드로 쉽게 띄울 수 있습니다.
        
        아래는 KOAPY 를 활용하는 예시 스크립트 입니다:
        
        ..  .. literalinclude:: ../koapy/examples/6_main_scenario.py
                    :language: python
        
        .. code-block:: python
        
            import logging
            import threading
        
            import grpc
        
            from koapy import KiwoomOpenApiPlusEntrypoint
            from koapy import KiwoomOpenApiPlusRealType
        
            from pprint import PrettyPrinter
            from google.protobuf.json_format import MessageToDict
            from pandas import Timestamp
            from exchange_calendars import get_calendar
        
            pp = PrettyPrinter()
            krx_calendar = get_calendar('XKRX')
        
            # 주문 테스트 전에 실제로 주문이 가능한지 확인 용도
            def is_currently_in_session():
                now = Timestamp.now(tz=krx_calendar.tz)
                previous_open = krx_calendar.previous_open(now).astimezone(krx_calendar.tz)
                next_close = krx_calendar.next_close(previous_open).astimezone(krx_calendar.tz)
                return previous_open <= now <= next_close
        
            with KiwoomOpenApiPlusEntrypoint() as context:
                # 로그인 예시
                logging.info('Logging in...')
                context.EnsureConnected()
                logging.info('Logged in.')
        
                # 기본 함수 호출 예시
                logging.info('Getting stock codes and names...')
                codes = context.GetCodeListByMarketAsList('0')
                names = [context.GetMasterCodeName(code) for code in codes]
        
                # 위에서 가져온 정보로 삼성전자의 code 확인
                codes_by_name = dict(zip(names, codes))
                logging.info('Checking stock code of Samsung...')
                samsung_code = codes_by_name['삼성전자']
                code = samsung_code
                logging.info('Code: %s', code)
        
                # TR 예시 (opt10081)
                logging.info('Getting daily stock data of Samsung...')
                data = context.GetDailyStockDataAsDataFrame(code)
                logging.info('Daily stock data:')
                print(data)
        
                # 조건검색 예시
                condition_name = '대형 저평가 우량주'
                logging.info('Getting stock codes with condition: %s', condition_name)
                codes, info = context.GetCodeListByCondition(condition_name, with_info=True)
                print(codes)
                print(info)
        
                # 주문처리 예시
                first_account_no = context.GetFirstAvailableAccount()
        
                request_name = '삼성전자 1주 시장가 신규 매수' # 사용자 구분명, 구분가능한 임의의 문자열
                screen_no = '0001'                           # 화면번호
                account_no = first_account_no                # 계좌번호 10자리, 여기서는 계좌번호 목록에서 첫번째로 발견한 계좌번호로 매수처리
                order_type = 1         # 주문유형, 1 : 신규매수
                code = samsung_code    # 종목코드, 앞의 삼성전자 종목코드
                quantity = 1           # 주문수량, 1주 매수
                price = 0              # 주문가격, 시장가 매수는 가격설정 의미없음
                quote_type = '03'      # 거래구분, 03 : 시장가
                original_order_no = '' # 원주문번호, 주문 정정/취소 등에서 사용
        
                # 현재는 기본적으로 주문수량이 모두 소진되기 전까지 이벤트를 듣도록 되어있음 (단순 호출 예시)
                if is_currently_in_session():
                    logging.info('Sending order to buy %s, quantity of 1 stock, at market price...', code)
                    for event in context.OrderCall(request_name, screen_no, account_no, order_type, code, quantity, price, quote_type, original_order_no):
                        pp.pprint(MessageToDict(event))
                else:
                    logging.info('Cannot send an order while market is not open, skipping...')
        
                # 실시간 예시
                code_list = [code]
                fid_list = KiwoomOpenApiPlusRealType.get_fids_by_realtype('주식시세')
                real_type = '0' # 기존 화면에 추가가 아니라 신규 생성
        
                # 현재는 기본적으로 실시간 이벤트를 무한정 가져옴 (커넥션 컨트롤 가능한 예시)
                logging.info('Starting to get realtime stock data for code: %s', code)
                stream = context.GetRealDataForCodesAsStream(code_list, fid_list, real_type, screen_no=None, infer_fids=True, readable_names=True, fast_parse=False)
        
                def stop_listening():
                    logging.info('Stopping to listen events...')
                    stream.cancel()
        
                threading.Timer(10.0, stop_listening).start() # 10초 이후에 gRPC 커넥션 종료하도록 설정
        
                # 이벤트 불러와서 출력처리
                try:
                    for event in stream:
                        pp.pprint(MessageToDict(event))
                except grpc.RpcError as e:
                    print(e)
        
                logging.info('End of example')
        
        
        이외에 사용법과 관련한 다양한 예시들은 examples_ 폴더에서 확인 가능합니다.
        
        .. _`키움증권의 OpenAPI`: https://www3.kiwoom.com/nkw.templateFrameSet.do?m=m1408000000
        
        .. _PyQt5: https://www.riverbankcomputing.com/software/pyqt/
        .. _PySide2: https://doc.qt.io/qtforpython/index.html
        .. _매뉴얼: https://download.kiwoom.com/web/openapi/kiwoom_openapi_plus_devguide_ver_1.5.pdf
        .. _KOAStudio: https://download.kiwoom.com/web/openapi/kiwoom_openapi_plus_devguide_ver_1.5.pdf#page=7
        .. _gRPC: https://grpc.io/
        .. _examples: https://github.com/elbakramer/koapy/tree/master/koapy/examples
        
        .. |QAxWidget| replace:: ``QAxWidget``
        .. _QAxWidget: https://doc.qt.io/qt-5/qaxwidget.html
        .. |dynamicCall| replace:: ``dynamicCall``
        .. _dynamicCall: https://doc.qt.io/qt-5/qaxbase.html#dynamicCall
        .. |signal| replace:: ``signal``
        .. _signal: https://doc.qt.io/qt-5/signalsandslots.html#signals
        .. |slot| replace:: ``slot``
        .. _slot: https://doc.qt.io/qt-5/signalsandslots.html#slots
        .. |pandas.DataFrame| replace:: ``pandas.DataFrame``
        .. _`pandas.DataFrame`: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html
        
        
        Installation
        ------------
        
        해당 라이브러리는 PyPI_ 를 통해서 설치 가능합니다:
        
        .. code-block:: console
        
            $ pip install koapy
        
        .. _PyPI: https://pypi.org/project/koapy/
        
        만약에 기본 기능 이외에 추가적인 기능들을 사용하고자 하는 경우, 아래처럼 추가적인 의존성까지 같이 설치해주셔야 합니다.
        
        예를 들어 backtrader_ 관련 기능들이 구현된 |koapy.backtrader|_ 모듈 하위의 기능들을 사용하고자 하는 경우,
        관련 의존성을 포함해 설치하기 위해서는 아래 명령을 실행합니다:
        
        .. code-block:: console
        
            $ pip install koapy[backtrader]
        
        .. _backtrader: https://github.com/mementum/backtrader
        
        자세한 설치방법과 관련해서는 Installation_ 을 참고하세요.
        
        ..  자세한 설치방법과 관련해서는 :doc:`./installation` 을 참고하세요.
        
        .. _Installation: https://koapy.readthedocs.io/en/latest/installation.html
        
        
        Usage
        -----
        
        설치 이후 세부적인 사용법에 대해서는 Usage_ 를 참고하세요.
        
        .. 설치 이후 세부적인 사용법에 대해서는 :doc:`./usage` 를 참고하세요.
        
        현재 알파 단계이기 때문에 많은 기능들이 실제로 문제없이 동작하는지 충분히 테스트되지 않았습니다.
        만약에 실전 트레이딩에 사용하려는 경우 자체적으로 충분한 테스트를 거친 후 사용하시기 바랍니다.
        개발자는 라이브러리 사용으로 인해 발생하는 손실에 대해 어떠한 책임도 지지 않습니다.
        
        또한 알파 단계에서 개발이 진행되면서 라이브러리의 구조가 계속 급격하게 변경될 수 있으니 참고 바랍니다.
        
        .. _Usage: https://koapy.readthedocs.io/en/latest/usage.html
        
        Licensing
        ---------
        
        KOAPY 는 다중 라이선스 방식으로 배포되며,
        사용자는 자신의 의도 및 사용 방식에 따라 아래 라이선스 옵션들 중 하나를 선택해 사용할 수 있습니다.
        
        * `MIT License`_
        * `Apache License 2.0`_
        * `GNU General Public License v3.0`_ or later
        
        라이선스 선택과 관련하여 추천하는 가이드라인은 아래와 같습니다.
        
        * `MIT License`_
        
          * 일반적인 사용자에게 알맞습니다.
          * 짧고 단순한 라이선스를 선호하시면 해당 라이선스를 선택하세요.
        
        * `Apache License 2.0`_
        
          * MIT 라이선스와 큰 차이는 없지만, 특허와 관련해서 명시적인 허가조항이 있습니다.
          * 추후 특허권 침해 소송이 우려되는 경우 MIT 라이선스 대신에 선택하시면 됩니다.
        
        * `GNU General Public License v3.0`_ or later
        
          * FSF_/GPL_ 이 추구하는 Copyleft_ 의 가치를 따르신다면 선택 가능한 옵션중 하나입니다.
          * 이외에 backtrader_ 관련 기능들을 활용하시는 경우, KOAPY 는 **반드시** GPLv3+ 로만 배포되어야 합니다.
          * 구체적으로 아래와 같은 경우들에 하나라도 포함된다면 GPLv3+ 배포 조건에 해당됩니다.
        
            * 설치시 ``pip install koapy[backtrader]`` 명령으로 설치
            * 사용시 |koapy.backtrader|_ 모듈 하위의 기능들을 사용
        
          * 이것은 backtrader_ 가 GPLv3+ 로 배포되고 있으며,
            해당 라이선스의 요구사항에 따라 그것을 사용하는 소프트웨어 또한 GPLv3+ 로 배포되어야 하기 때문입니다.
        
          * 추가로 PySide2_ 대신 PyQt5_ 를 사용하는 경우에도 비슷한 이유로 KOAPY 는 **반드시** GPLv3 로만 배포되어야 합니다.
          * 구체적으로 아래 컴포넌트들에서 PySide2_ 혹은 PyQt5_ 가 필요합니다.
        
            * |koapy.backend.kiwoom_openapi_plus.core.KiwoomOpenApiPlusQAxWidget|_
            * |koapy.backend.kiwoom_openapi_plus.grpc.KiwoomOpenApiPlusTrayApplication|_
        
          * 설치시 ``pip install koapy[PyQt5]`` 명령으로 설치가 필요합니다.
        
        각 라이선스의 허가 및 요구사항과 관련해서 쉽게 정리된 내용은 `tl;drLegal`_ 에서 참고하실 수 있습니다.
        
        다만 위의 내용이 법률적 조언은 아닌 점 참고 바랍니다.
        
        .. _`MIT License`: https://spdx.org/licenses/MIT.html
        .. _`Apache License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
        .. _`GNU General Public License v3.0`: https://www.gnu.org/licenses/gpl-3.0.html
        
        .. _FSF: https://www.fsf.org/
        .. _GPL: https://www.gnu.org/licenses/licenses.html#GPL
        .. _Copyleft: https://www.gnu.org/licenses/copyleft.html
        
        .. _backtrader: https://github.com/mementum/backtrader
        
        .. _`tl;drLegal`: https://tldrlegal.com/
        
        .. |koapy.backtrader| replace:: ``koapy.backtrader``
        .. _`koapy.backtrader`: https://github.com/elbakramer/koapy/tree/master/koapy/backtrader
        
        .. |koapy.backend.kiwoom_openapi_plus.core.KiwoomOpenApiPlusQAxWidget| replace:: ``koapy.backend.kiwoom_openapi_plus.core.KiwoomOpenApiPlusQAxWidget``
        .. _`koapy.backend.kiwoom_openapi_plus.core.KiwoomOpenApiPlusQAxWidget`: https://github.com/elbakramer/koapy/blob/master/koapy/backend/kiwoom_openapi_plus/core/KiwoomOpenApiQAxWidget.py
        .. |koapy.backend.kiwoom_openapi_plus.grpc.KiwoomOpenApiPlusTrayApplication| replace:: ``koapy.backend.kiwoom_openapi_plus.grpc.KiwoomOpenApiPlusTrayApplication``
        .. _`koapy.backend.kiwoom_openapi_plus.grpc.KiwoomOpenApiPlusTrayApplication`: https://github.com/elbakramer/koapy/blob/master/koapy/backend/kiwoom_openapi_plus/core/KiwoomOpenApiTrayApplication.py
        
        
        Reference
        ---------
        
        개발과정에 있어서 참고하거나 전체적인 투자과정에서 같이 보면 좋을 것 같아 보이는 자료들을 모아봤습니다.
        
        * `파이썬으로 배우는 알고리즘 트레이딩`_
        * `퀀트투자를 위한 키움증권 API (파이썬 버전)`_
        * `시스템 트레이딩`_
        * `systrader79의 왕초보를 위한 주식투자`_
        
        .. _`파이썬으로 배우는 알고리즘 트레이딩`: https://wikidocs.net/book/110
        .. _`퀀트투자를 위한 키움증권 API (파이썬 버전)`: https://wikidocs.net/book/1173
        .. _`시스템 트레이딩`: https://igotit.tistory.com/840
        .. _`systrader79의 왕초보를 위한 주식투자`: https://stock79.tistory.com/
        
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.12 (2020-10-11)
        -------------------
        
        * Latest release.
        
        0.1.2 (2020-09-19)
        ------------------
        
        * First release on PyPI.
        
Keywords: koapy
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Natural Language :: Korean
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Environment :: Console
Classifier: Environment :: X11 Applications :: Qt
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.7.1
Provides-Extra: backtrader
Provides-Extra: PyQt5
