bw-essentials-core 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

bw_essentials/constants/services.py

@@ -18,3 +18,5 @@ class Services(Enum):
     PAYMENT = 'Payment'
     MODEL_PORTFOLIO = "Model_Portfolio"
     PROMETHEUS_USER_APP = "Prometheus_User_App"
+    PORTFOLIO_CATALOGUE = "Portfolio_Catalogue"
+    PORTFOLIO_CONTENT = "Portfolio_Content"

bw_essentials/services/notification.py

@@ -28,10 +28,11 @@ class NotificationService(ApiClient):
         self.name = Services.NOTIFICATION.value
         self.base_url = self.get_base_url(self.name)
         self.urls = {
-            "whatsapp": "whatsapp"
+            "whatsapp": "whatsapp",
+            "email": "email"
         }
 
-    def _whatsapp(self, title, template, platform, params, to, user_id):
+    def _whatsapp(self, title, template, platform, params, to, user_id) -> None:
         """
         Sends a WhatsApp notification.
 
@@ -66,12 +67,77 @@ class NotificationService(ApiClient):
         resp_data = self._post(url=self.base_url, endpoint=self.urls.get('whatsapp'), data=payload)
         logger.info(f"Whatsapp response {resp_data =}")
 
-    def send_whatsapp(self, template, title, params, to, user_id):
-        logger.info(f"In - send_whatsapp_notification {user_id =} {title = } {params = } {to = }")
+    def send_whatsapp(self, template, title, params, to, user_id) -> None:
+        """
+
+        Args:
+            template (str): Template for the WhatsApp message.
+            title (str): Title of the notification.
+            params: Parameters for the notification message.
+            to (str): Recipient's whatsapp number.
+            user_id (str): The ID of the user receiving the notification.
 
+        Returns:
+            None
+        """
+        logger.info(f"In - send_whatsapp_notification {user_id =} {title = } {params = } {to = }")
         self._whatsapp(title=title,
                        template=template,
                        platform=self._get_env_var(NotificationService.PLATFORM),
                        params=params,
                        to=to,
                        user_id=user_id)
+
+    def _email(self, title: str, content: str, platform: str, to: str, user_id: str) -> None:
+        """
+        Sends an email notification using the internal notification service.
+
+        Args:
+            title (str): The subject or title of the email.
+            content (str): The HTML or plain text body of the email.
+            platform (str): The platform identifier from which the email is sent (e.g., 'prometheus').
+            to (str): Recipient's email address.
+            user_id (str): The ID of the user for tracking or logging purposes.
+
+        Returns:
+            None
+
+        """
+        logger.info(f"In - email {user_id =}, {to =}, {title =}, {platform =}, {content =}")
+        payload = {
+            "to": to,
+            "userId": user_id,
+            "platform": platform,
+            "title": title,
+            "content": content
+        }
+        logger.info(f"email {payload =}")
+        headers = {
+            'api-key': self._get_env_var(NotificationService.NOTIFICATION_API_KEY),
+            'Content-Type': 'application/json'
+        }
+        self.set_headers(headers)
+        resp_data = self._post(url=self.base_url, endpoint=self.urls.get('email'), json=payload)
+        logger.info(f"Email response {resp_data =}")
+
+    def send_email(self, title: str, content: str, to: str, user_id: str) -> None:
+        """
+        Sends an email notification to the specified recipient.
+
+        Args:
+            title (str): The subject or title of the email.
+            content (str): The HTML or plain text content of the email.
+            to (str): The recipient's email address.
+            user_id (str): The ID of the user associated with the notification.
+
+        Returns:
+            None
+        """
+        logger.info(f"In - send_email {user_id =}, {title =}, {to =}")
+        self._email(
+            title=title,
+            content=content,
+            platform=self._get_env_var(NotificationService.PLATFORM),
+            to=to,
+            user_id=user_id
+        )

bw_essentials/services/portfolio_catalogue.py

@@ -0,0 +1,104 @@
+"""portfolio_catalogue.py
+
+Client wrapper for interacting with the Portfolio-Catalogue Service API.
+
+This module exposes `PortfolioCatalogue`, a thin abstraction over the
+shared :class:`bw_essentials.services.api_client.ApiClient` that collates
+all URL templates and common logic required to communicate with the
+Portfolio-Catalogue micro-service responsible for portfolio construction
+and rebalancing operations.
+
+Features
+--------
+- Centralised mapping of service endpoints.
+- Uniform request/response logging using the shared API client helper.
+- Simple, type-hinted public interface that hides low-level HTTP calls.
+
+Example
+-------
+>>> from bw_essentials.services.portfolio_catalogue import PortfolioCatalogue
+>>> client = PortfolioCatalogue(service_user="system")
+>>> data = {
+  "portfolioId": "BASKE_e3f7fc",
+  "startDate": "2025-07-01",
+  "endDate": "2025-07-10",
+  "status": "active",
+  "createdBy": "KP",
+  "constituents": [
+    {
+      "symbol": "EROSMEDIA",
+      "weight": 0.5,
+      "isin": "INE416L01017",
+      "status": "active",
+      "rationale": "Hello"
+    },
+    {
+      "symbol": "IDEA",
+      "weight": 0.5,
+      "isin": "INE669E01016",
+      "status": "active",
+      "rationale": "Hello"
+    }
+  ]
+}
+>>> response = client.create_rebalance(json=data)
+>>> print(response)
+"""
+
+import logging
+from typing import Optional, Dict, Any
+
+from bw_essentials.constants.services import Services
+from bw_essentials.services.api_client import ApiClient
+
+logger = logging.getLogger(__name__)
+
+
+class PortfolioCatalogue(ApiClient):
+    """High-level client for the Portfolio-Catalogue Service.
+
+    This class bundles together the logic for generating fully-qualified
+    endpoint URLs and executing authenticated HTTP requests for
+    portfolio rebalancing workflows.
+
+    Attributes
+    ----------
+    base_url : str
+        Resolved base URL for the Portfolio-Catalogue service obtained
+        from configuration or environment variables.
+    name : str
+        Canonical service identifier used for logging and telemetry.
+    urls : dict[str, str]
+        Mapping of human-readable keys to relative endpoint paths.
+    """
+
+    def __init__(self, service_user: str):
+        super().__init__(user=service_user)
+        self.base_url = self.get_base_url(Services.PORTFOLIO_CATALOGUE.value)
+        self.name = Services.PORTFOLIO_CATALOGUE.value
+        self.urls = {
+            "rebalance": "rebalance",
+        }
+
+    def create_rebalance(self, json: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+        """Submit a rebalance request.
+
+        Parameters
+        ----------
+        json : dict
+            Request payload describing the rebalance parameters and
+            portfolio metadata.
+
+        Returns
+        -------
+        dict
+            Parsed JSON response returned by the service.
+        """
+        logger.info("In - create_rebalance %s", json)
+        data = self._post(
+            url=self.base_url,
+            endpoint=self.urls["rebalance"],
+            json=json,
+        )
+        logger.info("%s", data)
+        return data

bw_essentials/services/portfolio_content.py

@@ -0,0 +1,69 @@
+"""portfolio_content.py
+
+Client wrapper for the Portfolio-Content Service API.
+
+This module exposes :class:`PortfolioContent`, a light-weight abstraction
+around :class:`bw_essentials.services.api_client.ApiClient` that
+centralises endpoint definitions and adds structured logging when
+querying portfolio content (e.g. constituent list, metadata).
+
+Example
+-------
+>>> from bw_essentials.services.portfolio_content import PortfolioContent
+>>> client = PortfolioContent(service_user="system")
+>>> details = client.get_portfolio_details("BASKE_e3f7fc")
+>>> print(details)
+"""
+
+import logging
+from typing import Optional, Dict, Any
+
+from bw_essentials.constants.services import Services
+from bw_essentials.services.api_client import ApiClient
+
+logger = logging.getLogger(__name__)
+
+
+class PortfolioContent(ApiClient):
+    """High-level client for the Portfolio-Content Service.
+
+    Attributes
+    ----------
+    base_url : str
+        Resolved base URL of the Portfolio-Content micro-service.
+    name : str
+        Canonical service identifier for logging/telemetry.
+    urls : dict[str, str]
+        Mapping of friendly names to relative endpoint paths.
+    """
+
+    def __init__(self, service_user: str):
+        super().__init__(user=service_user)
+        self.base_url = self.get_base_url(Services.PORTFOLIO_CONTENT.value)
+        self.name = Services.PORTFOLIO_CONTENT.value
+        self.urls = {
+            "portfolio": "portfolio",
+        }
+
+    def get_portfolio_details(self, portfolio_id: str) -> Optional[Dict[str, Any]]:
+        """Retrieve full details of a portfolio.
+
+        Parameters
+        ----------
+        portfolio_id : str
+            Unique identifier of the portfolio whose details should be
+            fetched.
+
+        Returns
+        -------
+        Optional[dict]
+            Parsed JSON response if the request succeeds, otherwise
+            ``None``.
+        """
+        logger.info("In - get_portfolio_details %s", portfolio_id)
+        data = self._get(
+            url=self.base_url,
+            endpoint=f"{self.urls['portfolio']}/{portfolio_id}"
+        )
+        logger.info("%s", data)
+        return data

{bw_essentials_core-0.1.2.dist-info → bw_essentials_core-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bw-essentials-core
-Version: 0.1.2
+Version: 0.1.4
 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.1.2.dist-info → bw_essentials_core-0.1.4.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=ymvYcXjJpWQoGnnCnqURhQao61QJAMM-g9sJCx_Y8s4,561
+bw_essentials/constants/services.py,sha256=IcJNd2w7bfEjvEvrkKg9te_71l4rntvU_g4gOMbmrDE,653
 bw_essentials/data_loch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bw_essentials/data_loch/data_loch.py,sha256=iJO0oPhZyQjoUZOaeBP1nsbuc5iR9ZNWoAXj2pGEpT8,11716
 bw_essentials/email_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -16,12 +16,14 @@ bw_essentials/services/broker.py,sha256=As-VT1MxkCD9p-13dQJDwf0_aEJVA6H0wNqL-EYH
 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/notification.py,sha256=OQD-rB7FaqcoyjRgFyl2pgeXWIgtYcUhRs_4uT1Em9A,2634
+bw_essentials/services/notification.py,sha256=q4jIZzIWIHvn-XaIIbkEjjhkYUV8ZGQWUXaY4NNRFgI,5078
+bw_essentials/services/portfolio_catalogue.py,sha256=sLS7tYW7AkCEXYt8oWdXhmzgzvHCH9nKKFl47y8-c9c,3070
+bw_essentials/services/portfolio_content.py,sha256=rdFTTsUUIt-AgFfA1SAItqg2njakVOm4dUKU0FHZQ2E,2148
 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.1.2.dist-info/METADATA,sha256=Bpm1zfFijl-hOhODELxsMOlhbuQXR8YwQ77kniBeSnI,7501
-bw_essentials_core-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-bw_essentials_core-0.1.2.dist-info/top_level.txt,sha256=gDc5T_y5snwKGXDQUusEus-FEt0RFwG644Yn_58wQOQ,14
-bw_essentials_core-0.1.2.dist-info/RECORD,,
+bw_essentials_core-0.1.4.dist-info/METADATA,sha256=H8GOOZwwtDbXU-DtWLK1LCMFOlyuXAeX9KD9X8Wmt0c,7501
+bw_essentials_core-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bw_essentials_core-0.1.4.dist-info/top_level.txt,sha256=gDc5T_y5snwKGXDQUusEus-FEt0RFwG644Yn_58wQOQ,14
+bw_essentials_core-0.1.4.dist-info/RECORD,,