fugle-marketdata 0.1.1a0__tar.gz

fugle_marketdata-0.1.1a0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Fortuna Intelligence Co., Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fugle_marketdata-0.1.1a0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.1
+Name: fugle-marketdata
+Version: 0.1.1a0
+Summary: Fugle Realtime API 1.0 client library for Python
+Home-page: https://github.com/fugle-dev/fugle-realtime-py#readme
+License: MIT
+Keywords: fugle,realtime,stock
+Author: Fortuna Intelligence Co., Ltd.
+Author-email: development@fugle.tw
+Requires-Python: >=3.7,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: pyee (>=9.0.4,<10.0.0)
+Requires-Dist: requests (>=2.28.2,<3.0.0)
+Requires-Dist: websocket-client (>=1.5.1,<2.0.0)
+Project-URL: Documentation, https://developer.fugle.tw
+Project-URL: Repository, https://github.com/fugle-dev/fugle-realtime-py
+Description-Content-Type: text/markdown
+
+[![PyPI version][pypi-image]][pypi-url]
+[![Python version][python-image]][python-url]
+[![Build Status][action-image]][action-url]
+# Fugle MarketData
+
+[![PyPI version][pypi-image]][pypi-url]
+[![Python version][python-image]][python-url]
+[![Build Status][action-image]][action-url]
+
+> Fugle MarketData API client library for Node.js
+
+## Installation
+
+```sh
+$ pip install fugle-marketdata
+```
+
+## Importing
+
+```py
+from fugle_marketdata import WebSocketClient, RestClient
+
+```
+
+## Usage
+
+The library is an isomorphic Python client that supports REST API and WebSocket.
+
+### REST API
+
+```py
+
+# def main():
+#     client = RestClient(api_key=TOKEN)
+#     stock = client.stock
+#     print(stock.intraday.quote(symbol="2330"))
+
+
+client = RestClient(api_key = 'YOUR_API_KEY')
+stock = client.stock  # Stock REST API client
+print(stock.intraday.quote(symbol="2330"))
+```
+
+### WebSocket API
+
+```py
+
+from fugle_marketdata import WebSocketClient, RestClient
+import asyncio
+
+def handle_message(message):
+    print(message)
+
+async def main():
+    client = WebSocketClient(api_key = 'YOUR_API_KEY')
+    stock = client.stock
+    stock.on("message", handle_message)
+    await stock.connect()
+    stock.subscribe({ 
+        "channel": 'trades', 
+        "symbol": '2330' 
+        })
+if __name__ == "__main__":
+    asyncio.run(main())
+
+```
+
+## License
+
+[MIT](LICENSE)
+
+

fugle_marketdata-0.1.1a0/README.md

@@ -0,0 +1,71 @@
+[![PyPI version][pypi-image]][pypi-url]
+[![Python version][python-image]][python-url]
+[![Build Status][action-image]][action-url]
+# Fugle MarketData
+
+[![PyPI version][pypi-image]][pypi-url]
+[![Python version][python-image]][python-url]
+[![Build Status][action-image]][action-url]
+
+> Fugle MarketData API client library for Node.js
+
+## Installation
+
+```sh
+$ pip install fugle-marketdata
+```
+
+## Importing
+
+```py
+from fugle_marketdata import WebSocketClient, RestClient
+
+```
+
+## Usage
+
+The library is an isomorphic Python client that supports REST API and WebSocket.
+
+### REST API
+
+```py
+
+# def main():
+#     client = RestClient(api_key=TOKEN)
+#     stock = client.stock
+#     print(stock.intraday.quote(symbol="2330"))
+
+
+client = RestClient(api_key = 'YOUR_API_KEY')
+stock = client.stock  # Stock REST API client
+print(stock.intraday.quote(symbol="2330"))
+```
+
+### WebSocket API
+
+```py
+
+from fugle_marketdata import WebSocketClient, RestClient
+import asyncio
+
+def handle_message(message):
+    print(message)
+
+async def main():
+    client = WebSocketClient(api_key = 'YOUR_API_KEY')
+    stock = client.stock
+    stock.on("message", handle_message)
+    await stock.connect()
+    stock.subscribe({ 
+        "channel": 'trades', 
+        "symbol": '2330' 
+        })
+if __name__ == "__main__":
+    asyncio.run(main())
+
+```
+
+## License
+
+[MIT](LICENSE)
+

fugle_marketdata-0.1.1a0/fugle_marketdata/__init__.py

@@ -0,0 +1,4 @@
+from .rest import RestClientFactory as RestClient
+from .websocket import WebSocketClientFactory as WebSocketClient
+
+__version__ = '0.1.0'

fugle_marketdata-0.1.1a0/fugle_marketdata/client_factory.py

@@ -0,0 +1,8 @@
+class ClientFactory:
+    def __init__(self, **options):
+        self.options = options
+        print(options)
+        if not self.options.get('api_key') and not self.options.get('bearer_token'):
+            raise TypeError('One of the "api_key" or "bearer_token" options must be specified')
+        if self.options.get('api_key') and self.options.get('bearer_token'):
+            raise TypeError('One and only one of the "api_key" or "bearer_token" options must be specified')

fugle_marketdata-0.1.1a0/fugle_marketdata/constants.py

@@ -0,0 +1,11 @@
+FUGLE_MARKETDATA_API_REST_BASE_URL = 'https://api.fugle.tw/marketdata'
+FUGLE_MARKETDATA_API_WEBSOCKET_BASE_URL = 'wss://api.fugle.tw/marketdata'
+FUGLE_MARKETDATA_API_VERSION = 'v1.0'
+
+CONNECT_EVENT = 'connect'
+DISCONNECT_EVENT = 'disconnect'
+MESSAGE_EVENT = 'message'
+ERROR_EVENT = 'error'
+AUTHENTICATED_EVENT = 'authenticated'
+UNAUTHENTICATED_EVENT = 'unauthenticated'
+UNAUTHENTICATED_MESSAGE = 'Invalid authentication credentials'

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/__init__.py

@@ -0,0 +1,2 @@
+from .factory import RestClientFactory
+from .base_rest import BaseRest

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/base_rest.py

@@ -0,0 +1,22 @@
+from urllib.parse import urlencode
+import requests
+
+class BaseRest(object):
+    def __init__(self, **config):
+        self.config = config
+
+    def request(self, path, **params):
+        baseUrl = self.config['base_url']
+        headers = {}
+        if self.config.get('api_key'):
+            headers['X-API-KEY'] = self.config['api_key']
+        if self.config.get('bearer_token'):
+            headers['Authorization'] = f"Bearer {self.config['bearer_token']}"
+
+        endpoint = path if (path.startswith('/')) else '/' + path
+
+        if len(params) == 0:
+            query = ''
+        else:
+            query = '?' + urlencode(params)
+        return requests.get(baseUrl + endpoint + query, headers=headers).json()

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/factory.py

@@ -0,0 +1,38 @@
+from fugle_marketdata.client_factory import ClientFactory
+from ..constants import FUGLE_MARKETDATA_API_REST_BASE_URL, FUGLE_MARKETDATA_API_VERSION
+from .stock import RestStockClient
+from .futopt import RestFutOptClient
+
+
+class RestClientFactory(ClientFactory):
+    def __init__(self, **options):
+        super().__init__(**options)
+        self.__clients = {}
+        self.options = options
+
+    @property
+    def stock(self):
+        return self.get_client('stock')
+
+    @property
+    def futopt(self):
+        return self.get_client('futopt')
+
+    def get_client(self, type):
+
+        base_url = f"{FUGLE_MARKETDATA_API_REST_BASE_URL}/{FUGLE_MARKETDATA_API_VERSION}/{type}"
+
+        if type in self.__clients:
+            return self.__clients[type]
+
+        if type == 'stock':
+            client = RestStockClient(base_url=base_url, **self.options)
+
+        elif type == 'futopt':
+            client = RestFutOptClient(base_url=base_url, **self.options)
+
+        else:
+            None
+
+        self.__clients[type] = client
+        return client

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/futopt/__init__.py

@@ -0,0 +1,2 @@
+from .client import RestFutOptClient
+

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/futopt/client.py

@@ -0,0 +1,13 @@
+from .intraday import Intraday
+
+
+
+class RestFutOptClient:
+    def __init__(self, **config):
+        # config: base_url, api_key?, bearer_token?
+        self.config = config
+
+    @property
+    def intraday(self):
+        return Intraday(**self.config)
+    

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/futopt/intraday.py

@@ -0,0 +1,20 @@
+from ..base_rest import BaseRest
+
+class Intraday(BaseRest):
+    def contracts(self, **params):
+        return self.request(f"intraday/contracts", **params)
+    
+    def products(self, **params):
+        return self.request(f"intraday/products", **params)
+    
+    def ticker(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"intraday/ticker/{symbol}", **params)
+    
+    def quote(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"intraday/quote/{symbol}", **params)
+    
+    def candles(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"intraday/candles/{symbol}", **params)

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/stock/__init__.py

@@ -0,0 +1 @@
+from .client import RestStockClient

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/stock/client.py

@@ -0,0 +1,21 @@
+from .intraday import Intraday
+from .historical import Historical
+from .snapshot import Snapshot
+
+
+class RestStockClient:
+    def __init__(self, **config):
+        # config: base_url, api_key?, bearer_token?
+        self.config = config
+
+    @property
+    def intraday(self):
+        return Intraday(**self.config)
+    
+    @property
+    def historical(self):
+        return Historical(**self.config)
+    
+    @property
+    def snapshot(self):
+        return Snapshot(**self.config)

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/stock/historical.py

@@ -0,0 +1,11 @@
+from ..base_rest import BaseRest
+
+class Historical(BaseRest):
+    def candles(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"historical/candles/{symbol}", **params)
+    
+    def stats(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"historical/stats/{symbol}", **params)
+    

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/stock/intraday.py

@@ -0,0 +1,26 @@
+from ..base_rest import BaseRest
+
+class Intraday(BaseRest):
+    def tickers(self, **params):
+        return self.request(f"intraday/tickers", **params)
+    
+    def ticker(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"intraday/ticker/{symbol}", **params)
+    
+    def quote(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"intraday/quote/{symbol}", **params)
+    
+    def candles(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"intraday/candles/{symbol}", **params)
+    
+    def trades(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"intraday/trades/{symbol}", **params)
+    
+    def volumes(self, **params):
+        symbol = params.pop('symbol')
+        return self.request(f"intraday/volumes/{symbol}", **params)
+    

fugle_marketdata-0.1.1a0/fugle_marketdata/rest/stock/snapshot.py

@@ -0,0 +1,15 @@
+from ..base_rest import BaseRest
+
+class Snapshot(BaseRest):
+    def quotes(self, **params):
+        market = params.pop('market')
+        return self.request(f"snapshot/quotes/{market}", **params)
+    
+    def movers(self, **params):
+        market = params.pop('market')
+        return self.request(f"snapshot/movers/{market}", **params)
+    
+    def actives(self, **params):
+        market = params.pop('market')
+        return self.request(f"snapshot/actives/{market}", **params)
+    

fugle_marketdata-0.1.1a0/fugle_marketdata/websocket/__init__.py

@@ -0,0 +1 @@
+from .factory import WebSocketClientFactory

fugle_marketdata-0.1.1a0/fugle_marketdata/websocket/client.py

@@ -0,0 +1,102 @@
+import asyncio
+import json
+import websocket
+from pyee import EventEmitter
+
+from ..constants import (
+    CONNECT_EVENT, 
+    DISCONNECT_EVENT, 
+    MESSAGE_EVENT, 
+    ERROR_EVENT, 
+    AUTHENTICATED_EVENT, 
+    UNAUTHENTICATED_EVENT, 
+    UNAUTHENTICATED_MESSAGE
+)
+
+class WebSocketClient():
+    def __init__(self, **config):
+        self.config = config
+        # config: base_url, api_key?, bearer_token?
+        self.ee = EventEmitter()
+        self.ee.on(CONNECT_EVENT, self.__authenticate)
+        self.__ws = websocket.WebSocketApp(
+            self.config.get('base_url'),
+            on_open=self.on_open,
+            on_close=self.on_close,
+            on_error=self.on_error,
+            on_message=self.on_message)
+        self.loop = asyncio.get_event_loop()
+        self.future = self.loop.create_future()
+        
+    def subscribe(self, params):
+        message = {
+            "event": "subscribe",
+            "data": params
+        }
+        self.__send(message)
+
+    def unsubscribe(self, params):
+        message = {
+            "event": "unsubscribe",
+            "data": params
+        }
+        self.__send(message)
+
+    def __authenticate(self, ws):
+        if self.config.get('api_key'):
+            auth_info = {
+                'event': 'auth',
+                'data': {
+                    'apikey': self.config['api_key']
+                }
+            }
+        elif self.config.get('bearer_token'):
+            auth_info = {
+                'event': 'auth',
+                'data': {
+                    'token': self.config['bearer_token']
+                }
+            }
+        else: 
+            None # error
+
+        self.__send(auth_info)
+
+    def __send(self, message):
+        print(message)
+        self.__ws.send(json.dumps(message))
+
+    def on_open(self, ws):
+        self.ee.emit(CONNECT_EVENT, ws)
+
+    def on_close(self, close_status_code, close_msg):
+        self.ee.emit(DISCONNECT_EVENT, close_msg)
+
+    def on_message(self, ws, data):
+        message = json.loads(data)
+        self.ee.emit(MESSAGE_EVENT, data)
+        if message['event'] == AUTHENTICATED_EVENT:
+            self.ee.emit(AUTHENTICATED_EVENT, message)
+            self.loop.call_soon_threadsafe(self.future.set_result, 'success')
+        elif message['event'] == ERROR_EVENT:
+            if message['data'] and message['data']['message'] == UNAUTHENTICATED_MESSAGE:
+                self.ee.emit(UNAUTHENTICATED_EVENT, message)
+                self.loop.call_soon_threadsafe(self.future.set_exception, 'login fail')
+       
+
+    def on_error(self, ws, error):
+        self.ee.emit("error", ws, error)
+
+    def on(self, event, listener):
+        self.ee.on(event, listener)
+
+    def off(self, event, listener):
+        self.ee.off(event, listener)
+
+    async def connect(self):
+        self.loop.run_in_executor(None, self.__ws.run_forever)
+        await self.future
+
+    def disconnect(self):
+        if self.__ws is not None:
+            self.__ws.close()

fugle_marketdata-0.1.1a0/fugle_marketdata/websocket/factory.py

@@ -0,0 +1,40 @@
+from fugle_marketdata.client_factory import ClientFactory
+from .futopt import WebSocketFutOptClient
+from .stock import WebSocketStockClient
+from ..constants import FUGLE_MARKETDATA_API_WEBSOCKET_BASE_URL, FUGLE_MARKETDATA_API_VERSION
+
+class WebSocketClientFactory(ClientFactory):
+    def __init__(self, **options):
+        super().__init__(**options)
+        self.__clients = {}
+        self.options = options
+
+    @property
+    def stock(self):
+        return self.get_client('stock')
+
+    @property
+    def futopt(self):
+        return self.get_client('futopt')
+
+    def get_client(self, type):
+
+        base_url = f"{FUGLE_MARKETDATA_API_WEBSOCKET_BASE_URL}/{FUGLE_MARKETDATA_API_VERSION}/{type}/streaming"
+                    
+        if type in self.__clients:
+            return self.__clients[type]
+        
+        if type == 'stock': 
+            client = WebSocketStockClient(base_url=base_url, **self.options)
+        elif type == 'futopt' :
+            client = WebSocketFutOptClient(base_url=base_url, **self.options)
+        else: 
+            None
+
+        self.__clients[type] = client
+        return client
+
+
+
+
+

fugle_marketdata-0.1.1a0/fugle_marketdata/websocket/futopt/__init__.py

@@ -0,0 +1 @@
+from .client import WebSocketFutOptClient

fugle_marketdata-0.1.1a0/fugle_marketdata/websocket/futopt/client.py

@@ -0,0 +1,4 @@
+from ..client import WebSocketClient
+
+class WebSocketFutOptClient(WebSocketClient):
+    pass

fugle_marketdata-0.1.1a0/fugle_marketdata/websocket/stock/__init__.py

@@ -0,0 +1 @@
+from .client import WebSocketStockClient

fugle_marketdata-0.1.1a0/fugle_marketdata/websocket/stock/client.py

@@ -0,0 +1,4 @@
+from ..client import WebSocketClient
+
+class WebSocketStockClient(WebSocketClient):
+    pass

fugle_marketdata-0.1.1a0/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "fugle-marketdata"
+version = "0.1.1a0"
+description = "Fugle Realtime API 1.0 client library for Python"
+authors = ["Fortuna Intelligence Co., Ltd. <development@fugle.tw>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/fugle-dev/fugle-realtime-py#readme"
+repository = "https://github.com/fugle-dev/fugle-realtime-py"
+documentation = "https://developer.fugle.tw"
+keywords = ["fugle", "realtime", "stock"]
+
+[tool.poetry.dependencies]
+python = "^3.7"
+requests = "^2.28.2"
+websocket-client = "^1.5.1"
+pyee = "^9.0.4"
+
+[tool.poetry.dev-dependencies]
+pytest = "^7.2.0"
+pytest-mock = "^3.6.1"
+pytest-cov = "^2.12.1"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"