hawk-sdk 0.0.17__py3-none-any.whl

hawk_sdk/api/__init__.py

@@ -0,0 +1,4 @@
+from hawk_sdk.api.equities.main import Equities
+from hawk_sdk.api.futures.main import Futures
+from hawk_sdk.api.ice_bofa_bonds_indices.main import ICEBofABondsIndices
+from hawk_sdk.api.system.main import System

hawk_sdk/api/equities/__init__.py

@@ -0,0 +1 @@
+from hawk_sdk.api.equities.main import Equities

hawk_sdk/api/equities/main.py

@@ -0,0 +1,44 @@
+"""
+@description: Datasource API for Equities data access and export functions.
+@author: Rithwik Babu
+"""
+from typing import List
+
+from hawk_sdk.api.equities.repository import EquitiesRepository
+from hawk_sdk.api.equities.service import EquitiesService
+from hawk_sdk.core.common.data_object import DataObject
+
+
+class Equities:
+    """Datasource API for fetching Futures data."""
+
+    def __init__(self, environment="production") -> None:
+        """Initializes the Equities datasource with required configurations."""
+        self.repository = EquitiesRepository(environment=environment)
+        self.service = EquitiesService(self.repository)
+
+    def get_adjusted_ohlcv(self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]) -> DataObject:
+        """Fetch open, high, low, close data for the given date range and hawk_ids.
+
+        :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 interval: The interval for the data query (e.g., '1d', '1h', '1m').
+        :param hawk_ids: A list of specific hawk_ids to filter by.
+        :return: A hawk DataObject containing the data.
+        """
+        return DataObject(
+            name="adjusted_equities_ohlcv",
+            data=self.service.get_adjusted_ohlcv(start_date, end_date, interval, hawk_ids)
+        )
+
+    def get_adjusted_ohlcv_snapshot(self, timestamp: str, hawk_ids: List[int]) -> DataObject:
+        """Fetch snapshot data for the given date and hawk_ids.
+
+        :param timestamp: The timestamp for the data query (YYYY-MM-DD HH:MM:SS).
+        :param hawk_ids: A list of specific hawk_ids to filter by.
+        :return: A hawk DataObject containing the data.
+        """
+        return DataObject(
+            name="equities_adjusted_ohlcv_snapshot",
+            data=self.service.get_adjusted_ohlcv_snapshot(timestamp, hawk_ids)
+        )

hawk_sdk/api/equities/repository.py

@@ -0,0 +1,158 @@
+"""
+@description: Repository layer for fetching Equities data from BigQuery.
+@author: Rithwik Babu
+"""
+import logging
+from typing import Iterator, List
+
+from google.cloud import bigquery
+
+from hawk_sdk.core.common.utils import get_bigquery_client
+
+
+class EquitiesRepository:
+    """Repository for accessing Equities raw data."""
+
+    def __init__(self, environment: str) -> None:
+        """Initializes the repository with a BigQuery client.
+
+        :param environment: The environment to fetch data from (e.g., 'production', 'development').
+        """
+        self.bq_client = get_bigquery_client()
+        self.environment = environment
+
+    def fetch_adjusted_ohlcv(self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]) -> Iterator[
+        dict]:
+        """Fetches raw adjusted OHLCV data from BigQuery for the given date range and hawk_ids using query parameters."""
+        open_field = f"adjusted_open_{interval}"
+        high_field = f"adjusted_high_{interval}"
+        low_field = f"adjusted_low_{interval}"
+        close_field = f"adjusted_close_{interval}"
+        volume_field = f"volume_{interval}"
+
+        query = f"""
+        WITH records_data AS (
+          SELECT 
+            r.record_timestamp AS date,
+            hi.value AS ticker,
+            MAX(CASE WHEN f.field_name = @open_field THEN r.double_value END) AS {open_field},
+            MAX(CASE WHEN f.field_name = @high_field THEN r.double_value END) AS {high_field},
+            MAX(CASE WHEN f.field_name = @low_field THEN r.double_value END) AS {low_field},
+            MAX(CASE WHEN f.field_name = @close_field THEN r.double_value END) AS {close_field},
+            MAX(CASE WHEN f.field_name = @volume_field THEN r.int_value END) AS {volume_field}
+          FROM 
+            `wsb-hc-qasap-ae2e.{self.environment}.records` AS r
+          JOIN 
+            `wsb-hc-qasap-ae2e.{self.environment}.fields` AS f
+            ON r.field_id = f.field_id
+          JOIN 
+            `wsb-hc-qasap-ae2e.{self.environment}.hawk_identifiers` AS hi
+            ON r.hawk_id = hi.hawk_id
+          WHERE 
+            r.hawk_id IN UNNEST(@hawk_ids)
+            AND f.field_name IN (@open_field, @high_field, @low_field, @close_field, @volume_field)
+            AND r.record_timestamp BETWEEN @start_date AND @end_date
+          GROUP BY 
+            date, ticker
+        )
+        SELECT DISTINCT
+          date,
+          ticker,
+          {open_field},
+          {high_field},
+          {low_field},
+          {close_field},
+          {volume_field}
+        FROM 
+          records_data
+        ORDER BY 
+          date;
+        """
+
+        query_params = [
+            bigquery.ArrayQueryParameter("hawk_ids", "INT64", hawk_ids),
+            bigquery.ScalarQueryParameter("start_date", "STRING", start_date),
+            bigquery.ScalarQueryParameter("end_date", "STRING", end_date),
+            bigquery.ScalarQueryParameter("open_field", "STRING", open_field),
+            bigquery.ScalarQueryParameter("high_field", "STRING", high_field),
+            bigquery.ScalarQueryParameter("low_field", "STRING", low_field),
+            bigquery.ScalarQueryParameter("close_field", "STRING", close_field),
+            bigquery.ScalarQueryParameter("volume_field", "STRING", volume_field)
+        ]
+
+        job_config = bigquery.QueryJobConfig(query_parameters=query_params)
+
+        try:
+            query_job = self.bq_client.query(query, job_config=job_config)
+            return query_job.result()
+        except Exception as e:
+            logging.error(f"Failed to fetch OHLC data: {e}")
+            raise
+
+    def fetch_adjusted_ohlcv_snapshot(self, timestamp: str, hawk_ids: List[int]) -> Iterator[dict]:
+        """Fetches the most recent snapshot data from BigQuery for the given time and hawk_ids."""
+        query = f"""
+        WITH latest_timestamp AS (
+          SELECT
+            MAX(r.record_timestamp) AS max_ts
+          FROM
+            `wsb-hc-qasap-ae2e.{self.environment}.records` AS r
+          WHERE
+            r.hawk_id IN UNNEST(@hawk_ids)
+            AND r.record_timestamp <= @timestamp
+        ),
+        records_data AS (
+          SELECT
+            r.record_timestamp AS date,
+            hi.value            AS ticker,
+            MAX(IF(f.field_name = 'adjusted_open_snapshot',  r.double_value, NULL)) AS adjusted_open_snapshot,
+            MAX(IF(f.field_name = 'adjusted_high_snapshot',  r.double_value, NULL)) AS adjusted_high_snapshot,
+            MAX(IF(f.field_name = 'adjusted_low_snapshot',   r.double_value, NULL)) AS adjusted_low_snapshot,
+            MAX(IF(f.field_name = 'adjusted_close_snapshot', r.double_value, NULL)) AS adjusted_close_snapshot,
+            MAX(IF(f.field_name = 'volume_snapshot',         r.int_value,    NULL)) AS volume_snapshot
+          FROM
+            `wsb-hc-qasap-ae2e.{self.environment}.records`            AS r
+          JOIN
+            `wsb-hc-qasap-ae2e.{self.environment}.fields`             AS f
+              ON r.field_id = f.field_id
+          JOIN
+            `wsb-hc-qasap-ae2e.{self.environment}.hawk_identifiers`   AS hi
+              ON r.hawk_id = hi.hawk_id
+          WHERE
+            r.hawk_id   IN UNNEST(@hawk_ids)
+            AND f.field_name IN (
+              'adjusted_open_snapshot', 'adjusted_high_snapshot',
+              'adjusted_low_snapshot',  'adjusted_close_snapshot',
+              'volume_snapshot'
+            )
+            AND r.record_timestamp = (SELECT max_ts FROM latest_timestamp)
+          GROUP BY
+            date, ticker
+        )
+        SELECT
+          date,
+          ticker,
+          adjusted_open_snapshot,
+          adjusted_high_snapshot,
+          adjusted_low_snapshot,
+          adjusted_close_snapshot,
+          volume_snapshot
+        FROM
+          records_data
+        ORDER BY
+          ticker;
+        """
+
+        query_params = [
+            bigquery.ArrayQueryParameter("hawk_ids", "INT64", hawk_ids),
+            bigquery.ScalarQueryParameter("timestamp", "TIMESTAMP", timestamp)
+        ]
+
+        job_config = bigquery.QueryJobConfig(query_parameters=query_params)
+
+        try:
+            query_job = self.bq_client.query(query, job_config=job_config)
+            return query_job.result()
+        except Exception as e:
+            logging.error(f"Failed to fetch snapshot data: {e}")
+            raise

hawk_sdk/api/equities/service.py

@@ -0,0 +1,51 @@
+"""
+@description: Service layer for processing and normalizing Equities data.
+@author: Rithwik Babu
+"""
+from typing import List, Iterator
+
+import pandas as pd
+
+from hawk_sdk.api.equities.repository import EquitiesRepository
+
+
+class EquitiesService:
+    """Service class for Futures business logic."""
+
+    def __init__(self, repository: EquitiesRepository) -> None:
+        """Initializes the service with a repository.
+
+        :param repository: An instance of FuturesRepository for data access.
+        """
+        self.repository = repository
+
+    def get_adjusted_ohlcv(self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]) -> pd.DataFrame:
+        """Equities and normalizes data into a pandas DataFrame.
+
+        :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 interval: The interval for the data query (e.g., '1d', '1h', '1m').
+        :param hawk_ids: A list of specific hawk_ids to filter by.
+        :return: A pandas DataFrame containing the normalized data.
+        """
+        raw_data = self.repository.fetch_adjusted_ohlcv(start_date, end_date, interval, hawk_ids)
+        return self._normalize_data(raw_data)
+
+    def get_adjusted_ohlcv_snapshot(self, timestamp: str, hawk_ids: List[int]) -> pd.DataFrame:
+        """Fetches and normalizes snapshot data for the given date and hawk_ids.
+
+        :param timestamp: The timestamp for the data query (YYYY-MM-DD HH:MM:SS).
+        :param hawk_ids: A list of specific hawk_ids to filter by.
+        :return: A pandas DataFrame containing the normalized data.
+        """
+        raw_data = self.repository.fetch_adjusted_ohlcv_snapshot(timestamp, hawk_ids)
+        return self._normalize_data(raw_data)
+
+    @staticmethod
+    def _normalize_data(data: Iterator[dict]) -> pd.DataFrame:
+        """Converts raw data into a normalized pandas DataFrame.
+
+        :param data: An iterator over raw data rows.
+        :return: A pandas DataFrame containing normalized data.
+        """
+        return pd.DataFrame([dict(row) for row in data])

hawk_sdk/api/futures/__init__.py

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

hawk_sdk/api/futures/main.py

@@ -0,0 +1,32 @@
+"""
+@description: Datasource API for Hawk Global Futures data access and export functions.
+@author: Rithwik Babu
+"""
+from typing import List
+
+from hawk_sdk.api.futures.repository import FuturesRepository
+from hawk_sdk.api.futures.service import FuturesService
+from hawk_sdk.core.common.data_object import DataObject
+
+
+class Futures:
+    """Datasource API for fetching Futures data."""
+
+    def __init__(self, environment="production") -> None:
+        """Initializes the Futures datasource with required configurations."""
+        self.repository = FuturesRepository(environment=environment)
+        self.service = FuturesService(self.repository)
+
+    def get_ohlcvo(self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]) -> DataObject:
+        """Fetch open, high, low, close, volume, and open interest data for the given date range and hawk_ids.
+
+        :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 interval: The interval for the data query (e.g., '1d', '1h', '1m').
+        :param hawk_ids: A list of specific hawk_ids to filter by.
+        :return: A hawk DataObject containing the data.
+        """
+        return DataObject(
+            name="futures_ohlcvo",
+            data=self.service.get_ohlcvo(start_date, end_date, interval, hawk_ids)
+        )

hawk_sdk/api/futures/repository.py

@@ -0,0 +1,86 @@
+"""
+@description: Repository layer for fetching Futures data from BigQuery.
+@author: Rithwik Babu
+"""
+import logging
+from typing import Iterator, List
+
+from google.cloud import bigquery
+
+from hawk_sdk.core.common.utils import get_bigquery_client
+
+
+class FuturesRepository:
+    """Repository for accessing Futures raw data."""
+
+    def __init__(self, environment: str) -> None:
+        """Initializes the repository with a BigQuery client.
+
+        :param environment: The environment to fetch data from (e.g., 'production', 'development').
+        """
+        self.bq_client = get_bigquery_client()
+        self.environment = environment
+
+    def fetch_ohlcvo(self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]) -> Iterator[dict]:
+        """Fetches raw OHLCVO data from BigQuery for the given date range and hawk_ids using query parameters."""
+        query = f"""
+        WITH records_data AS (
+          SELECT 
+            r.record_timestamp AS date,
+            hi.value AS ticker,
+            MAX(CASE WHEN f.field_name = @open_field THEN r.double_value END) AS open,
+            MAX(CASE WHEN f.field_name = @high_field THEN r.double_value END) AS high,
+            MAX(CASE WHEN f.field_name = @low_field THEN r.double_value END) AS low,
+            MAX(CASE WHEN f.field_name = @close_field THEN r.double_value END) AS close,
+            MAX(CASE WHEN f.field_name = @volume_field THEN r.int_value END) AS volume,
+            MAX(CASE WHEN f.field_name = @open_interest_field THEN r.int_value END) AS open_interest
+          FROM 
+            `wsb-hc-qasap-ae2e.{self.environment}.records` AS r
+          JOIN 
+            `wsb-hc-qasap-ae2e.{self.environment}.fields` AS f
+            ON r.field_id = f.field_id
+          JOIN 
+            `wsb-hc-qasap-ae2e.{self.environment}.hawk_identifiers` AS hi
+            ON r.hawk_id = hi.hawk_id
+          WHERE 
+            r.hawk_id IN UNNEST(@hawk_ids)
+            AND f.field_name IN (@open_field, @high_field, @low_field, @close_field, @volume_field, @open_interest_field)
+            AND r.record_timestamp BETWEEN @start_date AND @end_date
+          GROUP BY 
+            date, ticker
+        )
+        SELECT DISTINCT
+          date,
+          ticker,
+          open,
+          high,
+          low,
+          close,
+          volume,
+          open_interest
+        FROM 
+          records_data
+        ORDER BY 
+          date;
+        """
+
+        query_params = [
+            bigquery.ArrayQueryParameter("hawk_ids", "INT64", hawk_ids),
+            bigquery.ScalarQueryParameter("start_date", "STRING", start_date),
+            bigquery.ScalarQueryParameter("end_date", "STRING", end_date),
+            bigquery.ScalarQueryParameter("open_field", "STRING", f"open_{interval}"),
+            bigquery.ScalarQueryParameter("high_field", "STRING", f"high_{interval}"),
+            bigquery.ScalarQueryParameter("low_field", "STRING", f"low_{interval}"),
+            bigquery.ScalarQueryParameter("close_field", "STRING", f"close_{interval}"),
+            bigquery.ScalarQueryParameter("volume_field", "STRING", f"volume_{interval}"),
+            bigquery.ScalarQueryParameter("open_interest_field", "STRING", f"open_interest_{interval}"),
+        ]
+
+        job_config = bigquery.QueryJobConfig(query_parameters=query_params)
+
+        try:
+            query_job = self.bq_client.query(query, job_config=job_config)
+            return query_job.result()
+        except Exception as e:
+            logging.error(f"Failed to fetch OHLCVO data: {e}")
+            raise

hawk_sdk/api/futures/service.py

@@ -0,0 +1,41 @@
+"""
+@description: Service layer for processing and normalizing Futures data.
+@author: Rithwik Babu
+"""
+from typing import List, Iterator
+
+import pandas as pd
+
+from hawk_sdk.api.futures.repository import FuturesRepository
+
+
+class FuturesService:
+    """Service class for Futures business logic."""
+
+    def __init__(self, repository: FuturesRepository) -> None:
+        """Initializes the service with a repository.
+
+        :param repository: An instance of FuturesRepository for data access.
+        """
+        self.repository = repository
+
+    def get_ohlcvo(self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]) -> pd.DataFrame:
+        """Fetches and normalizes data into a pandas DataFrame.
+
+        :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 interval: The interval for the data query (e.g., '1d', '1h', '1m').
+        :param hawk_ids: A list of specific hawk_ids to filter by.
+        :return: A pandas DataFrame containing the normalized data.
+        """
+        raw_data = self.repository.fetch_ohlcvo(start_date, end_date, interval, hawk_ids)
+        return self._normalize_data(raw_data)
+
+    @staticmethod
+    def _normalize_data(data: Iterator[dict]) -> pd.DataFrame:
+        """Converts raw data into a normalized pandas DataFrame.
+
+        :param data: An iterator over raw data rows.
+        :return: A pandas DataFrame containing normalized data.
+        """
+        return pd.DataFrame([dict(row) for row in data])

hawk_sdk/api/ice_bofa_bonds_indices/__init__.py

@@ -0,0 +1 @@
+from hawk_sdk.api.ice_bofa_bonds_indices.main import ICEBofABondsIndices

hawk_sdk/api/ice_bofa_bonds_indices/main.py

@@ -0,0 +1,32 @@
+"""
+@description: Datasource API for ICE BofA Bonds data access and export functions.
+@author: Rithwik Babu
+"""
+from typing import List
+
+from hawk_sdk.api.ice_bofa_bonds_indices.repository import ICEBofABondsIndicesRepository
+from hawk_sdk.api.ice_bofa_bonds_indices.service import ICEBofABondsIndicesService
+from hawk_sdk.core.common.data_object import DataObject
+
+
+class ICEBofABondsIndices:
+    """Datasource API for fetching ICE BofA Bond Indices data."""
+
+    def __init__(self, environment="production") -> None:
+        """Initializes the ICE BofA Bonds Indices datasource with required configurations."""
+        self.repository = ICEBofABondsIndicesRepository(environment=environment)
+        self.service = ICEBofABondsIndicesService(self.repository)
+
+    def get_data(self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]) -> DataObject:
+        """Fetch data for hawk_ids.
+
+        :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 interval: The interval for the data query (e.g., '1d', '1h', '1m').
+        :param hawk_ids: A list of specific hawk_ids to filter by.
+        :return: A hawk DataObject containing the data.
+        """
+        return DataObject(
+            name="ice_bofa_bonds_index_data",
+            data=self.service.get_data(start_date, end_date, interval, hawk_ids)
+        )

hawk_sdk/api/ice_bofa_bonds_indices/repository.py

@@ -0,0 +1,91 @@
+"""
+@description: Repository layer for fetching ICE BofA Bonds Indices data from BigQuery.
+@author: Rithwik Babu
+"""
+import logging
+from typing import Iterator, List
+
+from google.cloud import bigquery
+
+from hawk_sdk.core.common.utils import get_bigquery_client
+
+
+class ICEBofABondsIndicesRepository:
+    """Repository for accessing ICE BofA Bonds Indices raw data."""
+
+    def __init__(self, environment: str) -> None:
+        """Initializes the repository with a BigQuery client.
+
+        :param environment: The environment to fetch data from (e.g., 'production', 'development').
+        """
+        self.bq_client = get_bigquery_client()
+        self.environment = environment
+
+    def fetch_data(
+            self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]
+    ) -> Iterator[dict]:
+        """Fetches raw data from BigQuery for the given date range and hawk_ids using query parameters."""
+        total_return_field = f"total_return_{interval}"
+        oas_field = f"oas_{interval}"
+        duration_modified_field = f"duration_modified_{interval}"
+        duration_effective_field = f"duration_effective_{interval}"
+        convexity_field = f"convexity_{interval}"
+
+        query = f"""
+        WITH records_data AS (
+          SELECT 
+            r.record_timestamp AS date,
+            hi.value AS ticker,
+            MAX(CASE WHEN f.field_name = @total_return_field THEN r.double_value END) AS {total_return_field},
+            MAX(CASE WHEN f.field_name = @oas_field THEN r.double_value END) AS {oas_field},
+            MAX(CASE WHEN f.field_name = @duration_modified_field THEN r.double_value END) AS {duration_modified_field},
+            MAX(CASE WHEN f.field_name = @duration_effective_field THEN r.double_value END) AS {duration_effective_field},
+            MAX(CASE WHEN f.field_name = @convexity_field THEN r.double_value END) AS {convexity_field}
+          FROM 
+            `wsb-hc-qasap-ae2e.{self.environment}.records` AS r
+          JOIN 
+            `wsb-hc-qasap-ae2e.{self.environment}.fields` AS f
+            ON r.field_id = f.field_id
+          JOIN 
+            `wsb-hc-qasap-ae2e.{self.environment}.hawk_identifiers` AS hi
+            ON r.hawk_id = hi.hawk_id
+          WHERE 
+            r.hawk_id IN UNNEST(@hawk_ids)
+            AND f.field_name IN (@total_return_field, @oas_field, @duration_modified_field, @duration_effective_field, @convexity_field)
+            AND r.record_timestamp BETWEEN @start_date AND @end_date
+          GROUP BY 
+            date, ticker
+        )
+        SELECT DISTINCT
+          date,
+          ticker,
+          {total_return_field},
+          {oas_field},
+          {duration_modified_field},
+          {duration_effective_field},
+          {convexity_field}
+        FROM 
+          records_data
+        ORDER BY 
+          date;
+        """
+
+        query_params = [
+            bigquery.ArrayQueryParameter("hawk_ids", "INT64", hawk_ids),
+            bigquery.ScalarQueryParameter("start_date", "STRING", start_date),
+            bigquery.ScalarQueryParameter("end_date", "STRING", end_date),
+            bigquery.ScalarQueryParameter("total_return_field", "STRING", total_return_field),
+            bigquery.ScalarQueryParameter("oas_field", "STRING", oas_field),
+            bigquery.ScalarQueryParameter("duration_modified_field", "STRING", duration_modified_field),
+            bigquery.ScalarQueryParameter("duration_effective_field", "STRING", duration_effective_field),
+            bigquery.ScalarQueryParameter("convexity_field", "STRING", convexity_field)
+        ]
+
+        job_config = bigquery.QueryJobConfig(query_parameters=query_params)
+
+        try:
+            query_job = self.bq_client.query(query, job_config=job_config)
+            return query_job.result()
+        except Exception as e:
+            logging.error(f"Failed to fetch data: {e}")
+            raise

hawk_sdk/api/ice_bofa_bonds_indices/service.py

@@ -0,0 +1,41 @@
+"""
+@description: Service layer for processing and normalizing Equities data.
+@author: Rithwik Babu
+"""
+from typing import List, Iterator
+
+import pandas as pd
+
+from hawk_sdk.api.ice_bofa_bonds_indices.repository import ICEBofABondsIndicesRepository
+
+
+class ICEBofABondsIndicesService:
+    """Service class for ICE BofA Bonds Indices business logic."""
+
+    def __init__(self, repository: ICEBofABondsIndicesRepository) -> None:
+        """Initializes the service with a repository.
+
+        :param repository: An instance of ICEBofABondsIndicesRepository for data access.
+        """
+        self.repository = repository
+
+    def get_data(self, start_date: str, end_date: str, interval: str, hawk_ids: List[int]) -> pd.DataFrame:
+        """ICE BofA Bonds Indices and normalizes data into a pandas DataFrame.
+
+        :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 interval: The interval for the data query (e.g., '1d', '1h', '1m').
+        :param hawk_ids: A list of specific hawk_ids to filter by.
+        :return: A pandas DataFrame containing the normalized data.
+        """
+        raw_data = self.repository.fetch_data(start_date, end_date, interval, hawk_ids)
+        return self._normalize_data(raw_data)
+
+    @staticmethod
+    def _normalize_data(data: Iterator[dict]) -> pd.DataFrame:
+        """Converts raw data into a normalized pandas DataFrame.
+
+        :param data: An iterator over raw data rows.
+        :return: A pandas DataFrame containing normalized data.
+        """
+        return pd.DataFrame([dict(row) for row in data])

hawk_sdk/api/system/__init__.py

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

hawk_sdk/api/system/main.py

@@ -0,0 +1,29 @@
+"""
+@description: Datasource API for Hawk System data access and export functions.
+@author: Rithwik Babu
+"""
+from typing import List
+
+from hawk_sdk.api.system.repository import SystemRepository
+from hawk_sdk.api.system.service import SystemService
+from hawk_sdk.core.common.data_object import DataObject
+
+
+class System:
+    """Datasource API for fetching System data."""
+
+    def __init__(self, environment="production") -> None:
+        """Initializes the System datasource with required configurations."""
+        self.repository = SystemRepository(environment=environment)
+        self.service = SystemService(self.repository)
+
+    def get_hawk_ids(self, tickers: List[str]) -> DataObject:
+        """Fetch hawk_ids for the given list of tickers.
+
+        :param tickers: A list of specific tickers to filter by.
+        :return: A hawk DataObject containing the hawk ID data.
+        """
+        return DataObject(
+            name="system_hawk_id_mappings",
+            data=self.service.get_hawk_ids(tickers)
+        )

hawk_sdk/api/system/repository.py

@@ -0,0 +1,53 @@
+"""
+@description: Repository layer for fetching System data from BigQuery.
+@author: Rithwik Babu
+"""
+import logging
+from typing import Iterator, List
+
+from google.cloud import bigquery
+
+from hawk_sdk.core.common.utils import get_bigquery_client
+
+
+class SystemRepository:
+    """Repository for accessing System data."""
+
+    def __init__(self, environment: str) -> None:
+        """Initializes the repository with a BigQuery client.
+
+        :param bq_client: An instance of BigQuery Client.
+        :param environment: The environment to fetch data from (e.g., 'production', 'development').
+        """
+        self.bq_client = get_bigquery_client()
+        self.environment = environment
+
+    def fetch_hawk_ids(self, tickers: List[str]) -> Iterator[dict]:
+        """Fetches hawk_ids for the given list of tickers from BigQuery.
+
+        :param tickers: A list of ticker strings to filter by.
+        :return: An iterator over raw data rows.
+        """
+        query = f"""
+        SELECT 
+            value AS ticker, 
+            hawk_id
+        FROM 
+            `wsb-hc-qasap-ae2e.{self.environment}.hawk_identifiers`
+        WHERE 
+            id_type = 'TICKER'
+            AND value IN UNNEST(@ticker_list)
+        """
+
+        query_params = [
+            bigquery.ArrayQueryParameter("ticker_list", "STRING", tickers),
+        ]
+
+        job_config = bigquery.QueryJobConfig(query_parameters=query_params)
+
+        try:
+            query_job = self.bq_client.query(query, job_config=job_config)
+            return query_job.result()
+        except Exception as e:
+            logging.error(f"Failed to fetch hawk_ids: {e}")
+            raise

hawk_sdk/api/system/service.py

@@ -0,0 +1,39 @@
+"""
+@description: Service layer for processing and normalizing System data.
+@author: Rithwik Babu
+"""
+
+from typing import List, Iterator
+
+import pandas as pd
+
+from hawk_sdk.api.system.repository import SystemRepository
+
+
+class SystemService:
+    """Service class for System business logic."""
+
+    def __init__(self, repository: SystemRepository) -> None:
+        """Initializes the service with a repository.
+
+        :param repository: An instance of SystemRepository for data access.
+        """
+        self.repository = repository
+
+    def get_hawk_ids(self, tickers: List[str]) -> pd.DataFrame:
+        """Fetches and normalizes hawk IDs into a pandas DataFrame.
+
+        :param tickers: A list of specific tickers to filter by.
+        :return: A pandas DataFrame containing the normalized hawk ID data.
+        """
+        raw_data = self.repository.fetch_hawk_ids(tickers)
+        return self._normalize_data(raw_data)
+
+    @staticmethod
+    def _normalize_data(data: Iterator[dict]) -> pd.DataFrame:
+        """Converts raw data into a normalized pandas DataFrame.
+
+        :param data: An iterator over raw data rows.
+        :return: A pandas DataFrame containing normalized data.
+        """
+        return pd.DataFrame([dict(row) for row in data])

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/core/common/constants.py

@@ -0,0 +1 @@
+PROJECT_ID = 'wsb-hc-qasap-ae2e'

hawk_sdk/core/common/data_object.py

@@ -0,0 +1,43 @@
+"""
+@description: Data Object class to handle output transformations.
+@author: Rithwik Babu
+"""
+import pandas as pd
+
+
+class DataObject:
+    def __init__(self, name, data):
+        self.__name = name
+        self.__data = data
+
+    def to_df(self) -> pd.DataFrame:
+        """Exports data to a pandas DataFrame.
+
+        :return: pd.Dataframe
+        """
+        return self.__data
+
+    def to_csv(self, file_name):
+        """Exports data to an Excel file.
+
+        :param file_name: The name of the output Excel file.
+        :return: None
+        """
+        self.__data.to_csv(file_name, index=False)
+
+    def to_xlsx(self, file_name):
+        """Exports data to an Excel file.
+
+        :param file_name: The name of the output Excel file.
+        :return: None
+        """
+        self.__data.to_excel(file_name, index=False)
+
+    def show(self, n=5):
+        """Print the first n rows of the data.
+
+        :param n: Number of rows to print.
+        :return: None, prints the head of the data.
+        """
+        print(self.__name)
+        print(self.__data.head(n))

hawk_sdk/core/common/utils.py

@@ -0,0 +1,23 @@
+import json
+import os
+
+from google.cloud import bigquery
+from google.oauth2 import service_account
+
+from hawk_sdk.core.common.constants import PROJECT_ID
+
+
+def get_bigquery_client() -> bigquery.Client:
+    service_account_json = os.environ.get('SERVICE_ACCOUNT_JSON')
+    if service_account_json:
+        # Use credentials provided in SERVICE_ACCOUNT_JSON
+        credentials = service_account.Credentials.from_service_account_info(
+            json.loads(service_account_json)
+        )
+        return bigquery.Client(project=PROJECT_ID, credentials=credentials)
+    else:
+        # Rely on Application Default Credentials (ADC),
+        # which will automatically use GOOGLE_APPLICATION_CREDENTIALS if set,
+        # or use the built-in credentials if running in GCP.
+        return bigquery.Client(project=PROJECT_ID)
+

hawk_sdk-0.0.17.dist-info/METADATA

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: hawk-sdk
+Version: 0.0.17
+Requires-Dist: google-cloud-bigquery
+Requires-Dist: pandas
+Dynamic: requires-dist

hawk_sdk-0.0.17.dist-info/RECORD

@@ -0,0 +1,28 @@
+hawk_sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hawk_sdk/api/__init__.py,sha256=YF7_NhjIYtWJmVPl66QADJ9JicxsM91e-9VB3RCT5hw,211
+hawk_sdk/api/equities/__init__.py,sha256=IyyiVMj4FRUbuNQHSHg_8fkKwGBDHeHLMyRhFeUZgxI,48
+hawk_sdk/api/equities/main.py,sha256=3jaDQsrRokP1R5jNJ_txjQbhAFeweEp4IrdU4OiPXJ8,1928
+hawk_sdk/api/equities/repository.py,sha256=YjsvEtUZh7L34_4IL86gCd3dJGnVc7fQ-Hd7F1gtzDE,6345
+hawk_sdk/api/equities/service.py,sha256=QVmLLzxppwJOJBigQVLbrEel2JbXySbWPRVU_-hVFew,2126
+hawk_sdk/api/futures/__init__.py,sha256=9mL1L6wlZKXTvMrTuQV35Fl9kTy4qjf3RIJzYBXcpeM,46
+hawk_sdk/api/futures/main.py,sha256=KYEqAts7tsMdjLSqEqUgOtdrbt7LDQ2LIL4qtL5yfqI,1391
+hawk_sdk/api/futures/repository.py,sha256=60HcrUKtwsMc0iH6rzOlST1sCvWoRLRh6Xp97d8fgTo,3548
+hawk_sdk/api/futures/service.py,sha256=kAzWLKeLXurD1qu8bCaFfjBwugZy2wtpdBmjibrdXmI,1564
+hawk_sdk/api/ice_bofa_bonds_indices/__init__.py,sha256=fhCZLQ50khLuNM106A-GQw2F2QuaOnXivhorKIRN03A,73
+hawk_sdk/api/ice_bofa_bonds_indices/main.py,sha256=TA4fPukMtXt4IGbEsub0nApbtwsOVlp89QIvxThl1vE,1433
+hawk_sdk/api/ice_bofa_bonds_indices/repository.py,sha256=wkUrnCBFU008mM04yXqa-v9ifEhHy7SPRhQfE2Fj4S8,3881
+hawk_sdk/api/ice_bofa_bonds_indices/service.py,sha256=-yc7s4dWIFIOUZT6GDjcVXfKUiF9dicp7L2umWJxSn0,1654
+hawk_sdk/api/system/__init__.py,sha256=Oy8XUp5WHx4fczjZXzfbkkHluHW-t7BLN4IgrOG6Pk4,44
+hawk_sdk/api/system/main.py,sha256=t2zWeEHSTYuWZAsqCMLt_CyRWoN8T8N6oEVshPgf6kk,1025
+hawk_sdk/api/system/repository.py,sha256=IllwoWXZyi46INuCRQeibHJaMDR1TfbT6l2uAhii2Xc,1654
+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/core/common/utils.py,sha256=yEMtrMYA7bv7cbIqa6sGWjQOAR3i0BOP2rh68PRMUe4,822
+hawk_sdk-0.0.17.dist-info/METADATA,sha256=fD3Gajq01oONdjFlLuYBe8BcqVgoTINZR_kuxLLSNEs,135
+hawk_sdk-0.0.17.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+hawk_sdk-0.0.17.dist-info/top_level.txt,sha256=aSjbudHcWSYsKXH9Wg0L1ltJfDOHXzjYFPO3v3cP-SE,9
+hawk_sdk-0.0.17.dist-info/RECORD,,

hawk_sdk-0.0.17.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

hawk_sdk-0.0.17.dist-info/top_level.txt

@@ -0,0 +1 @@
+hawk_sdk