siglab-py 0.2.1__tar.gz → 0.2.2__tar.gz

{siglab_py-0.2.1 → siglab_py-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: siglab_py
-Version: 0.2.1
+Version: 0.2.2
 Summary: Market data fetches, TA calculations and generic order gateway.
 Author: r0bbarh00d
 Author-email: r0bbarh00d <r0bbarh00d@gmail.com>

{siglab_py-0.2.1 → siglab_py-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "siglab_py"
-version = "0.2.01"
+version = "0.2.02"
 description = "Market data fetches, TA calculations and generic order gateway."
 authors = [{name = "r0bbarh00d", email = "r0bbarh00d@gmail.com"}]
 license = {text = "MIT"}

{siglab_py-0.2.1 → siglab_py-0.2.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = siglab_py
-version = 0.2.01
+version = 0.2.02
 description = Market data fetches, TA calculations and generic order gateway.
 author = r0bbarh00d
 author_email = r0bbarh00d@gmail.com

siglab_py-0.2.2/siglab_py/constants.py

@@ -0,0 +1,12 @@
+import enum
+from typing import Union, List, Dict, Any
+
+JSON_SERIALIZABLE_TYPES = Union[str, bool, int, float, None, List[Any], Dict[Any, Any]]
+
+class LogLevel(enum.Enum):
+    CRITICAL = 50
+    ERROR = 40
+    WARNING = 30
+    INFO = 20
+    DEBUG = 10
+    NOTSET = 0

{siglab_py-0.2.1 → siglab_py-0.2.2}/siglab_py/ordergateway/gateway.py

@@ -25,14 +25,19 @@ import ccxt.pro as ccxtpro
 
 from siglab_py.exchanges.any_exchange import AnyExchange
 from siglab_py.ordergateway.client import Order, DivisiblePosition
+from siglab_py.util.notification_util import dispatch_notification
+from siglab_py.constants import LogLevel
 
 '''
 Usage:
-    python gateway.py --gateway_id bybit_01 --default_type linear --rate_limit_ms 100
+    python gateway.py --gateway_id hyperliquid_01 --default_type linear --rate_limit_ms 100
 
     --default_type defaults to linear
     --rate_limit_ms defaults to 100
 
+    --slack_info_url, --slack_critical_url and --slack_alert_url are if you want gateway to dispatch Slack notification on events.
+    How to get Slack webhook urls? https://medium.com/@natalia_assad/how-send-a-table-to-slack-using-python-d1a20b08abe0
+
 This script is pypy compatible:
     pypy gateway.py --gateway_id bybit_01 --default_type linear --rate_limit_ms 100
 
@@ -82,7 +87,11 @@ To debug from vscode, launch.json:
                     "--aws_kms_key_id", "",
                     "--apikey", "xxx",
                     "--secret", "xxx",
-                    "--passphrase", "xxx"
+                    "--passphrase", "xxx",
+
+                    "--slack_info_url", "https://hooks.slack.com/services/xxx",
+                    "--slack_critial_url", "https://hooks.slack.com/services/xxx",
+                    "--slack_alert_url", "https://hooks.slack.com/services/xxx",
                 ],
                 "env": {
                     "PYTHONPATH": "${workspaceFolder}"
@@ -188,6 +197,17 @@ param : Dict = {
     "loop_freq_ms" : 500, # reduce this if you need trade faster
     "loops_random_delay_multiplier" : 1, # Add randomness to time between slices are sent off. Set to 1 if no random delay needed.
 
+    'notification' : {
+        'footer' : None,
+
+        # slack webhook url's for notifications
+        'slack' : {
+            'info' : { 'webhook_url' : None },
+            'critical' : { 'webhook_url' : None },
+            'alert' : { 'webhook_url' : None },
+        }
+    },
+
     'mds' : {
         'topics' : {
             
@@ -268,6 +288,10 @@ def parse_args():
     parser.add_argument("--secret", help="Exchange secret", default=None)
     parser.add_argument("--passphrase", help="Exchange passphrase", default=None)
 
+    parser.add_argument("--slack_info_url", help="Slack webhook url for INFO", default=None)
+    parser.add_argument("--slack_critial_url", help="Slack webhook url for CRITICAL", default=None)
+    parser.add_argument("--slack_alert_url", help="Slack webhook url for ALERT", default=None)
+
     args = parser.parse_args()
     param['gateway_id'] = args.gateway_id
 
@@ -297,6 +321,11 @@ def parse_args():
     param['secret'] = args.secret
     param['passphrase'] = args.passphrase
 
+    param['notification']['slack']['info'] = args.slack_info_url
+    param['notification']['slack']['critical'] = args.slack_critial_url
+    param['notification']['slack']['alert'] = args.slack_alert_url
+    param['notification']['footer'] = f"From gateway {param['gateway_id']}"
+
 def init_redis_client() -> StrictRedis:
     redis_client : StrictRedis = StrictRedis(
                     host = param['mds']['redis']['host'],
@@ -389,7 +418,8 @@ async def instantiate_exchange(
                 "walletAddress" : api_key,
                 "privateKey" : secret,
                 'enableRateLimit'  : True,
-                'rateLimit' : rate_limit_ms
+                'rateLimit' : rate_limit_ms,
+                "verbose": True,
             }
         )  # type: ignore
     else:
@@ -445,7 +475,8 @@ async def execute_one_position(
     exchange : AnyExchange,
     position : DivisiblePosition,
     param : Dict,
-    executions : Dict[str, Dict[str, Any]]
+    executions : Dict[str, Dict[str, Any]],
+    notification_params : Dict[str, Any]
 ):
     try:
         market : Dict[str, Any] = exchange.markets[position.ticker] if position.ticker in exchange.markets else None # type: ignore
@@ -710,7 +741,8 @@ async def execute_one_position(
 async def work(
     param : Dict,
     exchange : AnyExchange,
-    redis_client : StrictRedis
+    redis_client : StrictRedis,
+    notification_params : Dict[str, Any]
 ):
     incoming_orders_topic_regex : str = param['incoming_orders_topic_regex']
     incoming_orders_topic_regex = incoming_orders_topic_regex.replace("$GATEWAY_ID$", param['gateway_id'])
@@ -758,7 +790,7 @@ async def work(
                                 ]
 
                                 start = time.time()
-                                pending_executions = [ execute_one_position(exchange, position, param, executions) for position in positions ]
+                                pending_executions = [ execute_one_position(exchange, position, param, executions, notification_params) for position in positions ]
                                 await asyncio.gather(*pending_executions)
                                 order_dispatch_elapsed_ms = int((time.time() - start) *1000)
 
@@ -819,6 +851,8 @@ async def main():
         secret : str = param['secret']
         passphrase : str = param['passphrase']
 
+    notification_params : Dict[str, Any] = param['notification']
+
     if encrypt_decrypt_with_aws_kms:
         aws_kms_key_id = str(os.getenv('AWS_KMS_KEY_ID'))
 
@@ -843,6 +877,6 @@ async def main():
         balances = await exchange.fetch_balance() # type: ignore
         log(f"{param['gateway_id']}: account balances {balances}")
 
-        await work(param=param, exchange=exchange, redis_client=redis_client)
+        await work(param=param, exchange=exchange, redis_client=redis_client, notification_params=notification_params)
 
 asyncio.run(main())

{siglab_py-0.2.1 → siglab_py-0.2.2}/siglab_py/ordergateway/test_ordergateway.py

@@ -6,6 +6,7 @@ from typing import Any, Dict, List, Union
 import logging
 import json
 from redis import StrictRedis
+from sympy import false
 
 from ordergateway.client import DivisiblePosition, execute_positions
 from constants import JSON_SERIALIZABLE_TYPES
@@ -95,7 +96,7 @@ if __name__ == '__main__':
             side = 'sell',
             amount = 0.00100,
             leg_room_bps = 5,
-            reduce_only=True,
+            reduce_only=False,
             order_type = 'limit',
             slices=1,
             wait_fill_threshold_ms=60000,

siglab_py-0.2.2/siglab_py/util/notification_util.py

@@ -0,0 +1,69 @@
+import json
+from typing import Any, Dict, Union
+import pandas as pd
+import numpy as np
+from tabulate import tabulate
+
+from slack_notification_util import slack_dispatch_notification
+
+from siglab_py.constants import LogLevel
+
+def dispatch_notification(
+        title : str,
+        message : Union[str, Dict, pd.DataFrame],
+        footer : str,
+        params : Dict[str, Any],
+        log_level : LogLevel = LogLevel.INFO
+        ):
+    if isinstance(message, Dict):
+        _message = json.dumps(message, indent=2, separators=(' ', ':'))
+    elif isinstance(message, pd.DataFrame):
+        _message = tabulate(message, headers='keys', tablefmt='orgtbl') # type: ignore
+    else:
+        _message = message
+
+    slack_dispatch_notification(title, _message, footer, params, log_level)
+
+if __name__ == '__main__':
+    params : Dict[str, Any] = {
+        "slack" : {
+            "info" : {
+                "webhook_url" : "https://hooks.slack.com/services/xxx"
+            },
+            "critical" : {
+                "webhook_url" : "https://hooks.slack.com/services/xxx"
+            },
+            "alert" : {
+                "webhook_url" : "https://hooks.slack.com/services/xxx"
+            }
+      },
+    }
+
+    log_level : LogLevel = LogLevel.CRITICAL
+
+    title : str = "Test message"
+    footer : str = "... some footer .."
+
+    message1 : str = "Testing 1"
+    dispatch_notification(title=title, message=message1, footer=footer, params=params, log_level=log_level)
+
+    message2 : Dict[str, Any] = {
+        'aaa' : 123,
+        'bbb' : 456,
+        'ccc' : {
+            'ddd' : 789
+        }
+    }
+    dispatch_notification(title=title, message=message2, footer=footer, params=params, log_level=log_level)
+
+    start_date = pd.to_datetime('2024-01-01 00:00:00')
+    datetimes = pd.date_range(start=start_date, periods=20, freq='H')
+    np.random.seed(42)
+    close_prices = np.random.uniform(80000, 90000, size=20).round(2)
+    data : pd.DataFrame = pd.DataFrame({
+        'datetime': datetimes,
+        'close': close_prices
+    })
+    data['timestamp_ms'] = data['datetime'].astype('int64')
+    message3 = data
+    dispatch_notification(title=title, message=message3, footer=footer, params=params, log_level=log_level)

siglab_py-0.2.2/siglab_py/util/slack_notification_util.py

@@ -0,0 +1,61 @@
+'''
+https://medium.com/@natalia_assad/how-send-a-table-to-slack-using-python-d1a20b08abe0
+'''
+import sys
+from typing import Any, Dict
+import json
+import requests
+
+from siglab_py.constants import LogLevel
+
+def slack_dispatch_notification(
+        title : str,
+        message : str,
+        footer : str,
+        params : Dict[str, Any],
+        log_level : LogLevel = LogLevel.INFO
+):
+    slack_params = params['slack']
+
+    if log_level==LogLevel.INFO or log_level==LogLevel.DEBUG:
+        webhook_url = slack_params['info']['webhook_url']
+    elif log_level==LogLevel.ERROR or  log_level==LogLevel.CRITICAL:
+        webhook_url = slack_params['critical']['webhook_url']
+    elif log_level==LogLevel.ERROR or  log_level==LogLevel.CRITICAL:
+        webhook_url = slack_params['alert']['webhook_url']
+    else:
+        webhook_url = slack_params['info']['webhook_url']
+
+    slack_data = {
+        "username": "NotificationBot",
+        "type": "section",
+        "blocks": [
+            {
+                "type": "header",
+                "text": {
+                    "type": "plain_text",
+                    "text": f"{title}"
+                }
+            },
+            {
+                "type": "section",
+                "text": {
+                    "type": "mrkdwn",
+                    "text": message
+                }
+            },
+            {
+                "type": "section",
+                "text": {
+                    "type": "plain_text",
+                    "text": footer
+                }
+            }
+        ]
+    }
+
+    byte_length = str(sys.getsizeof(slack_data, 2000))
+    headers = {'Content-Type': "application/json", 'Content-Length': byte_length}
+    response = requests.post(webhook_url, data=json.dumps(slack_data), headers=headers)
+    if response.status_code != 200:
+        raise Exception(response.status_code, response.text)

{siglab_py-0.2.1 → siglab_py-0.2.2}/siglab_py.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: siglab-py
-Version: 0.2.1
+Version: 0.2.2
 Summary: Market data fetches, TA calculations and generic order gateway.
 Author: r0bbarh00d
 Author-email: r0bbarh00d <r0bbarh00d@gmail.com>

{siglab_py-0.2.1 → siglab_py-0.2.2}/siglab_py.egg-info/SOURCES.txt

@@ -34,4 +34,6 @@ siglab_py/util/__init__.py
 siglab_py/util/analytic_util.py
 siglab_py/util/aws_util.py
 siglab_py/util/market_data_util.py
-siglab_py/util/retry_util.py
+siglab_py/util/notification_util.py
+siglab_py/util/retry_util.py
+siglab_py/util/slack_notification_util.py

siglab_py-0.2.1/siglab_py/constants.py

@@ -1,3 +0,0 @@
-from typing import Union, List, Dict, Any
-
-JSON_SERIALIZABLE_TYPES = Union[str, bool, int, float, None, List[Any], Dict[Any, Any]]