bw-essentials-core 0.0.8__py3-none-any.whl → 0.1.0__py3-none-any.whl

bw_essentials/constants/services.py

@@ -17,3 +17,4 @@ class Services(Enum):
     USER_REPORTING = 'User_Reporting'
     PAYMENT = 'Payment'
     MODEL_PORTFOLIO = "Model_Portfolio"
+    PROMETHEUS_USER_APP = "Prometheus_User_App"

bw_essentials/services/market_pricer.py

@@ -67,7 +67,8 @@ class MarketPricer(ApiClient):
         self.name = Services.MARKET_PRICER.value
         self.urls = {
             "live": "live",
-            "eod": "eod"
+            "eod": "eod",
+            "index_performance": "index/{}/performance",
         }
 
     def get_live_prices(self, securities, exchange):
@@ -231,3 +232,71 @@ class MarketPricer(ApiClient):
 
         logger.info(f"{market_pricing_eod_response=}")
         return market_pricing_eod_response.get("data")
+
+    def get_index_performance_by_dates(self, index_name, start_date, end_date):
+        """
+        Fetches index performance metrics over a given date range.
+
+        Args:
+            index_name (str): The index name (e.g., "NIFTY50").
+            start_date (str): The start date for performance metrics in 'YYYY-MM-DD' format.
+            end_date (str): The end date for performance metrics in 'YYYY-MM-DD' format.
+
+        Returns:
+            dict: A dictionary containing cumulative return, volatility, drawdown, and a list
+                  of daily return data.
+                  Example:
+                    {
+                      "data": {
+                        "cumulative_return": 2.332968692796598,
+                        "volatility": 6.378354401960588,
+                        "drawdown": 0,
+                        "daily_returns": [
+                          {
+                            "date": "2025-06-05",
+                            "close": 22934.5,
+                            "daily_return": 0.5552912703301827,
+                            "current_weight": 100.55529127033019
+                          },
+                          {
+                            "date": "2025-06-06",
+                            "close": 23165.1,
+                            "daily_return": 1.0054721053434745,
+                            "current_weight": 101.56634667450024
+                          },
+                          {
+                            "date": "2025-06-09",
+                            "close": 23329.4,
+                            "daily_return": 0.7092565972087517,
+                            "current_weight": 102.28671268883305
+                          },
+                          {
+                            "date": "2025-06-10",
+                            "close": 23339.95,
+                            "daily_return": 0.04522190883606836,
+                            "current_weight": 102.3329686927966
+                          }
+                        ]
+                      },
+                      "success": true
+                    }
+        Raises:
+            ValueError: If input parameters are missing or invalid.
+        """
+        logger.info(f"In - get_index_performance_by_dates | {index_name=}, {start_date=}, {end_date=}")
+
+        if not all([index_name, start_date, end_date]):
+            logger.error("Missing required parameters for index performance fetch")
+            raise ValueError("index_name, start_date, and end_date are required")
+
+        endpoint = self.urls['index_performance'].format(index_name)
+        params = {"start_date": start_date, "end_date": end_date}
+        response = self._get(
+            url=self.base_url,
+            endpoint=endpoint,
+            params=params
+        )
+        logger.debug(f"Raw response from MarketPricer index API: {response}")
+        data = response.get("data")
+        logger.info("Out - get_index_performance_by_dates success")
+        return data

bw_essentials/services/user_app.py

@@ -0,0 +1,323 @@
+"""
+prometheus_user_app.py
+
+Module to interact with the Prometheus User App Service API.
+
+This module provides a high-level client wrapper around the Prometheus User App Service,
+enabling secure, structured, and logged communication with its endpoints. It includes:
+
+- Type-safe interfaces
+- Detailed request and response logging
+- Validated endpoint routing
+- Clear, maintainable service integration points
+"""
+
+from typing import Optional, Dict, Any
+import logging
+
+from bw_essentials.constants.services import Services
+from bw_essentials.services.api_client import ApiClient
+
+logger = logging.getLogger(__name__)
+
+
+class PrometheusUserApp(ApiClient):
+    """
+    Client for interacting with the Prometheus User App Service API.
+
+    This class handles API communication with Prometheus User App endpoints. It abstracts
+    request handling, URL construction, and logging while ensuring robust error management.
+
+    Attributes:
+        base_url (str): Base URL derived from tenant configuration
+        name (str): Service identifier
+        urls (Dict[str, str]): A dictionary of endpoint path templates
+    """
+
+    def __init__(self, service_user: str):
+        """
+        Initialize the PrometheusUserApp client with the given service user.
+
+        Args:
+            service_user (str): Username or service identifier for authentication.
+        """
+        super().__init__(user=service_user)
+        self.base_url = self.get_base_url(Services.PROMETHEUS_USER_APP.value)
+        self.name = Services.PROMETHEUS_USER_APP.value
+        self.urls = {
+            "user_details": "user/details",
+            "profile": "user/profile",
+            "get_profile": "user/profile/",
+            "login": "user/login",
+            "register_user": "user/register",
+            "update_dealer_disclaimer": "user/{}/dealer/disclaimer/",
+            "dealer_users": "user/{}/dealer/users",
+            "user_disclaimer": "user/{}/disclaimer/",
+            "dealer_login": "user/{}/login/dealer",
+            "send_otp": "user/{}/otp/send",
+            "verify_otp": "user/{}/otp/verify",
+            "register_dealer_user": "user/{}/register/dealer",
+            "sso": "user/{}/sso"
+        }
+
+    def get_user_details(self, user_id: str) -> Optional[Dict[str, Any]]:
+        """
+        Fetch detailed user information by user ID.
+
+        Args:
+            user_id (str): Unique identifier of the user.
+
+        Returns:
+            Optional[Dict[str, Any]]: Parsed user data if found, else None.
+        """
+        logger.info("Fetching user details for user_id=%s", user_id)
+        response = self._get(
+            endpoint=self.urls["user_details"],
+            url=self.base_url,
+            params={'user_id': user_id}
+        )
+        return response.get('data')
+
+    def update_user_profile(self, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Update the user profile with provided data.
+
+        Args:
+            data (Dict[str, Any]): Dictionary containing user profile updates.
+
+        Returns:
+            Optional[Dict[str, Any]]: Updated profile data if successful, else None.
+        """
+        logger.info("Updating user profile with data: %s", data)
+        response = self._put(
+            endpoint=self.urls["profile"],
+            url=self.base_url,
+            data=data
+        )
+        return response.get('data')
+
+    def login(self, user_id: str, password: str) -> Optional[Dict[str, Any]]:
+        """
+        Authenticate a user using credentials.
+
+        Args:
+            user_id (str): User identifier (e.g., username).
+            password (str): User password.
+
+        Returns:
+            Optional[Dict[str, Any]]: Auth token or login response if successful.
+        """
+        logger.info("Logging in user %s", user_id)
+        response = self._post(
+            endpoint=self.urls["login"],
+            url=self.base_url,
+            json={'username': user_id, 'password': password}
+        )
+        return response.get('data')
+
+    def get_user_profile(self, user_id: str) -> Optional[Dict[str, Any]]:
+        """
+        Retrieve profile details of a user.
+
+        Args:
+            user_id (str): Unique user identifier.
+
+        Returns:
+            Optional[Dict[str, Any]]: User profile information if successful.
+        """
+        logger.info("Fetching profile for user %s", user_id)
+        response = self._get(
+            endpoint=self.urls["get_profile"],
+            url=self.base_url
+        )
+        return response.get('data')
+
+    def register_user(self, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Register a new user with the service.
+
+        Args:
+            data (Dict[str, Any]): Registration details including user information.
+
+        Returns:
+            Optional[Dict[str, Any]]: Registration confirmation or created user details.
+        """
+        logger.info("Registering new user with data: %s", data)
+        response = self._post(
+            endpoint=self.urls["register_user"],
+            url=self.base_url,
+            json=data
+        )
+        return response
+
+    def update_dealer_disclaimer(self, broker: str, user_id: str, disclaimer_accepted: bool) -> Optional[Dict[str, Any]]:
+        """
+        Update a user's dealer disclaimer status.
+
+        Args:
+            broker (str): Broker identifier.
+            user_id (str): User ID whose disclaimer is being updated.
+            disclaimer_accepted (bool): Whether disclaimer is accepted.
+
+        Returns:
+            Optional[Dict[str, Any]]: Updated disclaimer status if successful.
+        """
+        logger.info("Updating dealer disclaimer for user_id=%s, broker=%s", user_id, broker)
+        response = self._put(
+            endpoint=self.urls["update_dealer_disclaimer"].format(broker),
+            url=self.base_url,
+            json={'disclaimer_accepted': disclaimer_accepted, 'user_id': user_id}
+        )
+        return response.get('data')
+
+    def dealer_users(self, broker: str, dealer_id: str) -> Optional[Dict[str, Any]]:
+        """
+        Get users associated with a specific dealer.
+
+        Args:
+            broker (str): Broker name.
+            dealer_id (str): Dealer identifier.
+
+        Returns:
+            Optional[Dict[str, Any]]: List of users or None if failed.
+        """
+        logger.info("Fetching dealer users for broker=%s, dealer_id=%s", broker, dealer_id)
+        response = self._post(
+            endpoint=self.urls["dealer_users"].format(broker),
+            url=self.base_url,
+            json={'dealer_id': dealer_id}
+        )
+        return response.get('data')
+
+    def user_disclaimer(self, broker: str, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Fetch disclaimer details for a user under a specific broker.
+
+        Args:
+            broker (str): Broker name.
+            data (Dict[str, Any]): Payload for disclaimer lookup.
+
+        Returns:
+            Optional[Dict[str, Any]]: Disclaimer information if available.
+        """
+        logger.info("Fetching user disclaimer for broker=%s, data=%s", broker, data)
+        response = self._post(
+            endpoint=self.urls["user_disclaimer"].format(broker),
+            url=self.base_url,
+            json=data
+        )
+        return response.get('data')
+
+    def dealer_login(self, broker: str, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Perform login for a dealer under the specified broker.
+
+        Args:
+            broker (str): Broker identifier.
+            data (Dict[str, Any]): Login payload.
+
+        Returns:
+            Optional[Dict[str, Any]]: Login response if successful.
+        """
+        logger.info("Dealer login request for broker=%s, data=%s", broker, data)
+        response = self._post(
+            endpoint=self.urls["dealer_login"].format(broker),
+            url=self.base_url,
+            json=data
+        )
+        return response.get('data')
+
+    def send_otp(self, broker: str, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Send OTP to user for verification under a broker.
+
+        Args:
+            broker (str): Broker name.
+            data (Dict[str, Any]): Payload including mobile/email.
+
+        Returns:
+            Optional[Dict[str, Any]]: Response with OTP status.
+        """
+        logger.info("Sending OTP for broker=%s, data=%s", broker, data)
+        response = self._post(
+            endpoint=self.urls["send_otp"].format(broker),
+            url=self.base_url,
+            json=data
+        )
+        return response.get('data')
+
+    def verify_otp(self, broker: str, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Verify user OTP under a broker.
+
+        Args:
+            broker (str): Broker name.
+            data (Dict[str, Any]): OTP verification data.
+
+        Returns:
+            Optional[Dict[str, Any]]: Verification status.
+        """
+        logger.info("Verifying OTP for broker=%s, data=%s", broker, data)
+        response = self._post(
+            endpoint=self.urls["verify_otp"].format(broker),
+            url=self.base_url,
+            json=data
+        )
+        return response.get('data')
+
+    def register_dealer_user(self, broker: str, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Register a new dealer user.
+
+        Args:
+            broker (str): Broker name.
+            data (Dict[str, Any]): Dealer user details.
+
+        Returns:
+            Optional[Dict[str, Any]]: Registration status or dealer user details.
+        """
+        logger.info("Registering dealer user for broker=%s, data=%s", broker, data)
+        response = self._post(
+            endpoint=self.urls["register_dealer_user"].format(broker),
+            url=self.base_url,
+            json=data
+        )
+        return response.get('data')
+
+    def update_dealer_user(self, broker: str, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Update an existing dealer user's information.
+
+        Args:
+            broker (str): Broker name.
+            data (Dict[str, Any]): Dealer user update payload.
+
+        Returns:
+            Optional[Dict[str, Any]]: Updated dealer user data.
+        """
+        logger.info("Updating dealer user for broker=%s, data=%s", broker, data)
+        response = self._put(
+            endpoint=self.urls["register_dealer_user"].format(broker),
+            url=self.base_url,
+            json=data
+        )
+        return response.get('data')
+
+    def sso(self, broker: str, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """
+        Perform Single Sign-On (SSO) operation.
+
+        Args:
+            broker (str): Broker identifier.
+            data (Dict[str, Any]): SSO payload.
+
+        Returns:
+            Optional[Dict[str, Any]]: SSO token or user session.
+        """
+        logger.info("Performing SSO for broker=%s, data=%s", broker, data)
+        response = self._post(
+            endpoint=self.urls["sso"].format(broker),
+            url=self.base_url,
+            json=data
+        )
+        return response.get('data')

{bw_essentials_core-0.0.8.dist-info → bw_essentials_core-0.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bw-essentials-core
-Version: 0.0.8
+Version: 0.1.0
 Summary: Reusable utilities for S3, email, Data Loch, Microsoft Teams Notifications and more.
 Author: InvestorAI
 Author-email: support+tech@investorai.in

{bw_essentials_core-0.0.8.dist-info → bw_essentials_core-0.1.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 bw_essentials/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bw_essentials/constants/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bw_essentials/constants/services.py,sha256=ZRz-cfumqafmAsetW48S3KMTjTaNAdoV1zu3bRuYfNc,513
+bw_essentials/constants/services.py,sha256=ymvYcXjJpWQoGnnCnqURhQao61QJAMM-g9sJCx_Y8s4,561
 bw_essentials/data_loch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bw_essentials/data_loch/data_loch.py,sha256=Ae3WIywFawThKcpsnf8nC8ldI9ARrSNqz8e5b6sINwY,11006
 bw_essentials/email_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -13,13 +13,14 @@ bw_essentials/s3_utils/s3_utils.py,sha256=wzjVrTX22_8PMX86svKFYGMZwgjBHbOaeEsxO-
 bw_essentials/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bw_essentials/services/api_client.py,sha256=74tKxhY_HiVCN3kgtk27a4GNznMaRphAspt9CWecuiY,7793
 bw_essentials/services/broker.py,sha256=As-VT1MxkCD9p-13dQJDwf0_aEJVA6H0wNqL-EYHO4g,8718
-bw_essentials/services/market_pricer.py,sha256=WAFcG5JfnqWxjzXRPrMdovPuKqWJIwa3ENvGAyEyjeM,8712
+bw_essentials/services/market_pricer.py,sha256=Qc9lxzAjhefAvjyEKsBPDu60bF6_61cnSpZNfjGMyDg,11755
 bw_essentials/services/master_data.py,sha256=2o_r2gdhIKBeTFgn5IIY-becgCEpYBymO4BKmixdV1g,11987
 bw_essentials/services/model_portfolio_reporting.py,sha256=iOtm4gyfU8P7C0R1gp6gUJI4ZRxJD5K2GLOalI_gToM,3249
 bw_essentials/services/trade_placement.py,sha256=PrzeU2XXC9HF1IQ1dMDM_ZHxmC491sOl-JbA6GWPwII,20772
+bw_essentials/services/user_app.py,sha256=_Y2NgDq6kEoco7ZRJ3-MMYJ-K2HGStJoFoeGOH_HotQ,11107
 bw_essentials/services/user_portfolio.py,sha256=_5M6yPfQt4MXedINBawEoPkb_o7IGzxPeHkvZkoQm8k,16191
 bw_essentials/services/user_portfolio_reporting.py,sha256=QaZzcw912Uos5ZafEaxLXDmCyetTFiVX3at3cTAv6MA,6003
-bw_essentials_core-0.0.8.dist-info/METADATA,sha256=GHHKudJ8VIoZ0nOUAeAnpQy0FYXXuPMSTQYA_aa3Wt0,7501
-bw_essentials_core-0.0.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-bw_essentials_core-0.0.8.dist-info/top_level.txt,sha256=gDc5T_y5snwKGXDQUusEus-FEt0RFwG644Yn_58wQOQ,14
-bw_essentials_core-0.0.8.dist-info/RECORD,,
+bw_essentials_core-0.1.0.dist-info/METADATA,sha256=jara8u2pGS_rtKqecDPjm1TkRMhy8GdZwFlmC7YYz5s,7501
+bw_essentials_core-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bw_essentials_core-0.1.0.dist-info/top_level.txt,sha256=gDc5T_y5snwKGXDQUusEus-FEt0RFwG644Yn_58wQOQ,14
+bw_essentials_core-0.1.0.dist-info/RECORD,,