hawk-sdk 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

hawk_sdk/__init__.py

@@ -1 +1 @@
-from hawk_sdk.futures import Futures
+from hawk_sdk.api.futures import Futures

hawk_sdk/api/__init__.py

@@ -0,0 +1,2 @@
+from hawk_sdk.api.futures.main import Futures
+from hawk_sdk.api.system.main import System

hawk_sdk/{futures → api/futures}/main.py

@@ -6,10 +6,10 @@ from typing import List
 
 from google.cloud import bigquery
 
-from hawk_sdk.common.constants import PROJECT_ID
-from hawk_sdk.common.data_object import DataObject
-from hawk_sdk.futures.repository import FuturesRepository
-from hawk_sdk.futures.service import FuturesService
+from hawk_sdk.core.common.constants import PROJECT_ID
+from hawk_sdk.core.common.data_object import DataObject
+from hawk_sdk.api.futures.repository import FuturesRepository
+from hawk_sdk.api.futures.service import FuturesService
 
 
 class Futures:
@@ -34,21 +34,3 @@ class Futures:
             name="futures_ohlcvo",
             data=self.service.get_ohlcvo(start_date, end_date, interval, hawk_ids)
         )
-
-    def get_hgf_model_state(self, start_date: str, end_date: str, short_ema: int, long_ema: int) -> DataObject:
-        """Fetch Hawk Global Futures model state data for the given date range.
-
-        :param start_date: The start date for the data query (YYYY-MM-DD).
-        :param end_date: The end date for the data query (YYYY-MM-DD).
-        :param short_ema: The short exponential moving average period.
-        :param long_ema: The long exponential moving average period.
-        :return: A hawk DataObject containing the model state data.
-        :raises ValueError: If short EMA period is longer than long EMA period.
-        """
-        if short_ema > long_ema:
-            raise ValueError("Short EMA period cannot be longer than Long EMA period.")
-
-        return DataObject(
-            name="futures_hgf_model_state",
-            data=self.service.get_hgf_model_state(start_date, end_date, short_ema, long_ema)
-        )

hawk_sdk/{futures → api/futures}/service.py

@@ -2,12 +2,11 @@
 @description: Service layer for processing and normalizing Futures data.
 @author: Rithwik Babu
 """
-from datetime import datetime, timedelta
 from typing import List, Iterator
 
 import pandas as pd
 
-from hawk_sdk.futures.repository import FuturesRepository
+from hawk_sdk.api.futures.repository import FuturesRepository
 
 
 class FuturesService:
@@ -32,37 +31,6 @@ class FuturesService:
         raw_data = self.repository.fetch_ohlcvo(start_date, end_date, interval, hawk_ids)
         return self._normalize_data(raw_data)
 
-    def get_hgf_model_state(
-            self, start_date: str, end_date: str, short_ema: int, long_ema: int
-    ) -> pd.DataFrame:
-        """Fetches and normalizes data into a pandas DataFrame.
-
-        :param start_date: The start date for the data query.
-        :param end_date: The end date for the data query.
-        :param short_ema: The short exponential moving average period.
-        :param long_ema: The long exponential moving average period.
-        :return: A pandas DataFrame containing the model state data.
-        """
-        adjusted_start_date = (
-                datetime.strptime(start_date, "%Y-%m-%d") - timedelta(days=long_ema)
-        ).strftime("%Y-%m-%d")
-
-        raw_data = self.repository.fetch_ohlcvo(
-            start_date=adjusted_start_date,
-            end_date=end_date,
-            interval="1d",
-            hawk_ids=list(range(20000, 20023))
-        )
-
-        raw_df = self._normalize_data(raw_data)
-
-        raw_df[f'EMA_{short_ema}'] = raw_df['close'].ewm(span=short_ema, adjust=False).mean()
-        raw_df[f'EMA_{long_ema}'] = raw_df['close'].ewm(span=long_ema, adjust=False).mean()
-
-        raw_df = raw_df[raw_df['date'] >= start_date]
-
-        return raw_df
-
     @staticmethod
     def _normalize_data(data: Iterator[dict]) -> pd.DataFrame:
         """Converts raw data into a normalized pandas DataFrame.

hawk_sdk/{system → api/system}/main.py

@@ -6,10 +6,10 @@ from typing import List
 
 from google.cloud import bigquery
 
-from hawk_sdk.common.constants import PROJECT_ID
-from hawk_sdk.common.data_object import DataObject
-from hawk_sdk.system.repository import SystemRepository
-from hawk_sdk.system.service import SystemService
+from hawk_sdk.core.common.constants import PROJECT_ID
+from hawk_sdk.core.common.data_object import DataObject
+from hawk_sdk.api.system.repository import SystemRepository
+from hawk_sdk.api.system.service import SystemService
 
 
 class System:

hawk_sdk/{system → api/system}/service.py

@@ -7,7 +7,7 @@ from typing import List, Iterator
 
 import pandas as pd
 
-from hawk_sdk.system.repository import SystemRepository
+from hawk_sdk.api.system.repository import SystemRepository
 
 
 class SystemService:

hawk_sdk/core/common/base_enum.py

@@ -0,0 +1,16 @@
+"""
+@description: Base enum class.
+@author: Rithwik Babu
+"""
+
+from enum import Enum
+
+
+class BaseEnum(str, Enum):
+    """
+    Base enum class used by all enum classes.
+
+    Note: Inheriting from str is necessary to correctly serialize output of enum
+    """
+
+    pass

hawk_sdk/{common → core/common}/data_object.py

@@ -1,3 +1,7 @@
+"""
+@description: Data Object class to handle output transformations.
+@author: Rithwik Babu
+"""
 import pandas as pd
 
 

{hawk_sdk-0.0.3.dist-info → hawk_sdk-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hawk-sdk
-Version: 0.0.3
+Version: 0.0.4
 Requires-Dist: google-cloud-bigquery
 Requires-Dist: pandas
 

hawk_sdk-0.0.4.dist-info/RECORD

@@ -0,0 +1,19 @@
+hawk_sdk/__init__.py,sha256=HD4fvSd8qbGXmLlUEJVs2QTCEruwtFp1jLKIjmlxQN8,41
+hawk_sdk/api/__init__.py,sha256=BD8XgbQ2o4EIzECUu4h6g-9jzpg--BiT6brrnyO4Puc,90
+hawk_sdk/api/futures/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hawk_sdk/api/futures/main.py,sha256=JcZXm1ZEfGzJAKXidv7ufnn_Vfb75O-E19JtquD7SSo,1553
+hawk_sdk/api/futures/repository.py,sha256=g8jSZCauCKwQYdjpZ3Oqe9NL8GjarDuSXDKpFl0J3vw,3588
+hawk_sdk/api/futures/service.py,sha256=kAzWLKeLXurD1qu8bCaFfjBwugZy2wtpdBmjibrdXmI,1564
+hawk_sdk/api/system/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hawk_sdk/api/system/main.py,sha256=FdpXaHp5yPFi17M1-1v4LU9vnwywkdYeOelps1hnKr0,1191
+hawk_sdk/api/system/repository.py,sha256=3CfFjNVC0X09TKLh9sfwd5HxeLcb49MRCbvb3Su2Wnk,1642
+hawk_sdk/api/system/service.py,sha256=LOZIfrEBKynJlj8V-4UM4abzVV9ogwUVxM7s2xFXlpo,1262
+hawk_sdk/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hawk_sdk/core/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hawk_sdk/core/common/base_enum.py,sha256=ZgC8gZjTzsoJzzdgN2DjYk3dVL_uM2Stuaky5bo6GuQ,267
+hawk_sdk/core/common/constants.py,sha256=KmsNfRVCwGeXEBHfo3TzSaDYJDMtnL-YEQKsO1DnWV8,33
+hawk_sdk/core/common/data_object.py,sha256=f4YO415Zz-lm3QYJQ3sJ4ugH9ZX9Dc7T-JvO4IdeyOw,1073
+hawk_sdk-0.0.4.dist-info/METADATA,sha256=RiX_vkzhUGuMGPlNTZzDSKuKkOi0YCmbYJLcVHXjk2g,112
+hawk_sdk-0.0.4.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+hawk_sdk-0.0.4.dist-info/top_level.txt,sha256=aSjbudHcWSYsKXH9Wg0L1ltJfDOHXzjYFPO3v3cP-SE,9
+hawk_sdk-0.0.4.dist-info/RECORD,,

hawk_sdk/futures/__init__.py

@@ -1 +0,0 @@
-from hawk_sdk.futures.main import Futures

hawk_sdk-0.0.3.dist-info/RECORD

@@ -1,16 +0,0 @@
-hawk_sdk/__init__.py,sha256=prH_sfjYeRZpBvyYYe5xV8lyn8auj1whvyftpBEHz_Y,37
-hawk_sdk/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hawk_sdk/common/constants.py,sha256=KmsNfRVCwGeXEBHfo3TzSaDYJDMtnL-YEQKsO1DnWV8,33
-hawk_sdk/common/data_object.py,sha256=qXsnDf__ePw4DbeF9Pe82B2DY05xsID9uU8vyfCUIe0,977
-hawk_sdk/futures/__init__.py,sha256=g0TubD9lrU2xoF1YvHSkNDjn3XehRT6zrIiSdX8C4no,42
-hawk_sdk/futures/main.py,sha256=AtK4uFKsXnpfnd3vEWWnmLj6xodUpGhuPVC3Nnr3cNM,2471
-hawk_sdk/futures/repository.py,sha256=g8jSZCauCKwQYdjpZ3Oqe9NL8GjarDuSXDKpFl0J3vw,3588
-hawk_sdk/futures/service.py,sha256=7Leuj6FyS6ulFf3kPuA9BO0wmA3bD_eYbl_mM7X4aoI,2811
-hawk_sdk/system/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hawk_sdk/system/main.py,sha256=C_PxjpEbTunW1U3pCaxGN8tYSMOCxEOC73My092wBoA,1173
-hawk_sdk/system/repository.py,sha256=3CfFjNVC0X09TKLh9sfwd5HxeLcb49MRCbvb3Su2Wnk,1642
-hawk_sdk/system/service.py,sha256=1QxvONep7E5-oN1Tiq8xoS-gyt4FVJQUed2ZTw_O0TM,1258
-hawk_sdk-0.0.3.dist-info/METADATA,sha256=7r9JRxT17LsAvXs4Fk_SDajl3JxQIX48l3KuTwv946Y,112
-hawk_sdk-0.0.3.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-hawk_sdk-0.0.3.dist-info/top_level.txt,sha256=aSjbudHcWSYsKXH9Wg0L1ltJfDOHXzjYFPO3v3cP-SE,9
-hawk_sdk-0.0.3.dist-info/RECORD,,