ipulse-shared-core-ftredge 2.8__tar.gz → 2.8.1__tar.gz

{ipulse_shared_core_ftredge-2.8/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-2.8.1}/PKG-INFO

@@ -1,10 +1,12 @@
 Metadata-Version: 2.1
 Name: ipulse_shared_core_ftredge
-Version: 2.8
-Summary: Shared models for the Pulse platform project. Using AI for financial advisory and investment management.
+Version: 2.8.1
+Summary: Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.
 Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
 Author: Russlan Ramdowar
 License-File: LICENCE
 Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: pytest~=7.1
+Requires-Dist: google-cloud-logging~=3.10.0
+Requires-Dist: google-cloud-error-reporting~=1.11.0

{ipulse_shared_core_ftredge-2.8 → ipulse_shared_core_ftredge-2.8.1}/README.md

@@ -1,2 +1,7 @@
 # ipulse_shared_core
 Shared Models like User, Organisation etc. Also includes shared enum_sets
+
+
+### Enums 
+
+Contains majority of all Enums used in Pulse

{ipulse_shared_core_ftredge-2.8 → ipulse_shared_core_ftredge-2.8.1}/setup.py

@@ -1,8 +1,9 @@
+# pylint: disable=import-error
 from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='2.8',
+    version='2.8.1',
     package_dir={'': 'src'},  # Specify the source directory
     packages=find_packages(where='src'),  # Look for packages in 'src'
     install_requires=[
@@ -10,8 +11,10 @@ setup(
         'pydantic[email]~=2.5',
         'python-dateutil~=2.8',
         'pytest~=7.1',
+        'google-cloud-logging~=3.10.0',
+        'google-cloud-error-reporting~=1.11.0'
     ],
     author='Russlan Ramdowar',
-    description='Shared models for the Pulse platform project. Using AI for financial advisory and investment management.',
+    description='Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.',
     url='https://github.com/TheFutureEdge/ipulse_shared_core',
 )

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/__init__.py

@@ -0,0 +1,18 @@
+# pylint: disable=missing-module-docstring
+from .models import ( UserAuth, UserProfile,
+                     UserStatus, UserProfileUpdate)
+
+from .enums import (TargetLogs,LogLevel,  Status, Unit, Frequency,
+                    Module, Domain, FinCoreCategory, FincCoreSubCategory,
+                    FinCoreRecordsCategory, FinancialExchangeOrPublisher,
+                    DataPrimaryCategory, DataState, DatasetScope,
+                    DataSourceType,PipelineTriggerType,DataOperationType,
+                    MatchConditionType, DuplicationHandling, DuplicationHandlingStatus,
+                    CodingLanguage, ExecutionLocation, ExecutionComputeType,
+                    CloudProvider,LoggingHandler)
+from .utils import (list_as_strings)
+
+from .logging import (get_logger,
+                      log_error,
+                      log_warning,
+                      log_info)

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/logging/__init__.py

@@ -0,0 +1 @@
+from .utils_logging import get_logger, log_error, log_warning, log_info

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/logging/logging_handlers_and_formatters.py

@@ -0,0 +1,144 @@
+# pylint: disable=missing-module-docstring
+# pylint: disable=missing-function-docstring
+# pylint: disable=logging-fstring-interpolation
+# pylint: disable=line-too-long
+# pylint: disable=missing-class-docstring
+# pylint: disable=broad-exception-caught
+
+import logging
+import traceback
+import json
+import os
+from google.cloud import error_reporting
+from google.cloud import logging as cloud_logging
+
+##########################################################################################################################
+####################################    Custom logging FORMATTERS    ##################################################### 
+##########################################################################################################################
+
+
+class CloudLogFormatter(logging.Formatter):
+    """Formats log records as structured JSON."""
+
+    def format(self, record):
+        log_entry = {
+            'message': record.msg,
+            'timestamp': self.formatTime(record, self.datefmt),
+            'name': record.name,
+            'severity': record.levelname,
+            'pathname': record.pathname,
+            'lineno': record.lineno,
+        }
+        if record.exc_info:
+            log_entry['exception_traceback'] = ''.join(traceback.format_exception(*record.exc_info))
+        if isinstance(record.msg, dict):
+            log_entry.update(record.msg)
+        return json.dumps(log_entry)
+
+
+class LocalLogFormatter(logging.Formatter):
+    """Formats log records for local output to the console."""
+
+    def format(self, record):  # Make sure you have the 'record' argument here!
+        path_parts = record.pathname.split(os.sep)
+
+        # Get the last two parts of the path if they exist
+        if len(path_parts) >= 2:
+            short_path = os.path.join(path_parts[-2], path_parts[-1])
+        else:
+            short_path = record.pathname
+        
+        # Format log messages differently based on the log level
+        if record.levelno == logging.INFO:
+            log_message = f"[INFO] {self.formatTime(record, self.datefmt)} :: {record.msg}"
+        elif record.levelno == logging.DEBUG:
+            log_message = f"[DEBUG] {self.formatTime(record, self.datefmt)} :: {record.msg} :: {short_path} :: lineno {record.lineno} :: {record.name}"
+        elif record.levelno == logging.ERROR:
+            log_message = f"[ERROR] {self.formatTime(record, self.datefmt)} :: {record.msg} :: {short_path} :: lineno {record.lineno} :: {record.name}"
+            if record.exc_info:
+                log_message += "\n" + ''.join(traceback.format_exception(*record.exc_info))
+        else:
+            log_message = f"[{record.levelname}] {self.formatTime(record, self.datefmt)} :: {record.msg} :: {short_path} :: lineno {record.lineno} :: {record.name}"
+
+
+        return log_message
+
+#############################################################################################################################################
+######################################## Logging handlers for Google Cloud ########################################
+#############################################################################################################################################
+
+class CustomGCPLoggingHandler(cloud_logging.handlers.CloudLoggingHandler):
+    """Custom handler for Google Cloud Logging with a dynamic logName."""
+    def __init__(self, client, name, resource=None, labels=None):
+        super().__init__(client=client, name=name, resource=resource, labels=labels)
+        self.client = client  # Ensure client is consistently used
+
+    def emit(self, record):
+        try:
+            # 1. Create the basic log entry dictionary
+            log_entry = {
+                'message': record.msg,
+                'severity': record.levelname,
+                'name': record.name,
+                'pathname': record.filename,
+                'lineno': record.lineno,
+            }
+            if record.exc_info:
+                log_entry['exception_traceback'] = ''.join(
+                    traceback.format_exception(*record.exc_info)
+                )
+
+            # 2. Apply the formatter to the 'message' field if it's a dictionary
+            if isinstance(record.msg, dict):
+                formatted_message = self.formatter.format(record)
+                try:
+                    log_entry['message'] = json.loads(formatted_message)
+                except json.JSONDecodeError:
+                    log_entry['message'] = formatted_message
+            else:
+                log_entry['message'] = record.msg
+
+            # 3. Set the custom logName
+            log_entry['logName'] = f"projects/{self.client.project}/logs/{record.name}"
+
+            # 4. Send to Google Cloud Logging
+            super().emit(record)
+        except Exception as e:
+            self.handleError(record)
+
+class CustomGCPErrorReportingHandler(logging.Handler):
+    def __init__(self, client=None, level=logging.ERROR):
+        super().__init__(level)
+        self.error_client = error_reporting.Client() if client is None else client
+        self.propagate = True
+
+    def emit(self, record):
+        try:
+            if record.levelno >= logging.ERROR:
+                log_struct = {
+                'message': self.format(record),
+                'severity': record.levelname,
+                'pathname': getattr(record, 'pathname', None),
+                'lineno': getattr(record, 'lineno', None)
+            }
+            if record.exc_info:
+                log_struct['exception'] = ''.join(
+                    traceback.format_exception(*record.exc_info)
+                )
+            self.error_client.report(str(log_struct))
+        except Exception as e:
+            self.handleError(record)
+
+
+def add_gcp_cloud_logging(logger, formatter, client=None):
+    """Sets up Google Cloud Logging for the logger."""
+    client = client or cloud_logging.Client()
+    handler = CustomGCPLoggingHandler(client, logger.name)
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+
+def add_gcp_error_reporting(logger, client=None):
+    """Sets up Google Cloud Error Reporting for the logger."""
+    client = client or error_reporting.Client()
+    handler = CustomGCPErrorReportingHandler(client=client)
+    logger.addHandler(handler)

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/logging/utils_logging.py

@@ -0,0 +1,72 @@
+# pylint: disable=missing-module-docstring
+# pylint: disable=missing-function-docstring
+# pylint: disable=logging-fstring-interpolation
+# pylint: disable=line-too-long
+# pylint: disable=missing-class-docstring
+# pylint: disable=broad-exception-caught
+import logging
+from typing import List, Union
+from ipulse_shared_core_ftredge.enums import LoggingHandler
+from ipulse_shared_core_ftredge.logging.logging_handlers_and_formatters import (CloudLogFormatter,
+                                                                                      LocalLogFormatter,
+                                                                                      add_gcp_cloud_logging,
+                                                                                      add_gcp_error_reporting)
+
+
+def get_logger( logger_name:str ,level=logging.INFO, logging_handler_providers: Union[LoggingHandler, List[LoggingHandler]] = LoggingHandler.NONE):
+
+    """Creates and configures a logger with the specified handlers."""
+
+    logger = logging.getLogger(logger_name)
+    logger.setLevel(level)
+    cloud_formatter = CloudLogFormatter()
+
+    # Ensure logging_handler_providers is a list for consistent processing
+    if not isinstance(logging_handler_providers, list):
+        logging_handler_providers = [logging_handler_providers]
+
+    supported_remote_handlers = [
+        LoggingHandler.GCP_CLOUD_LOGGING,
+        LoggingHandler.GCP_ERROR_REPORTING,
+        LoggingHandler.LOCAL_STREAM,
+        LoggingHandler.NONE, # If NONE is considered a remote handler
+    ]
+
+    # Remote handlers
+
+    for handler_provider in logging_handler_providers:
+        if handler_provider in supported_remote_handlers:
+            if handler_provider == LoggingHandler.GCP_CLOUD_LOGGING:
+                add_gcp_cloud_logging(logger, cloud_formatter)
+            elif handler_provider == LoggingHandler.GCP_ERROR_REPORTING:
+                add_gcp_error_reporting(logger)
+            elif handler_provider == LoggingHandler.LOCAL_STREAM:  # Handle local stream
+                local_handler = logging.StreamHandler()
+                local_handler.setFormatter(LocalLogFormatter())
+                logger.addHandler(local_handler)
+        else:
+            raise ValueError(
+            f"Unsupported logging provider: {handler_provider}. "
+            f"Supported providers: {[h.value for h in supported_remote_handlers]}"
+            )
+    return logger
+
+
+def log_error(msg,logger=None , print_out=False, exc_info=False):
+    if print_out:
+        print(msg)
+    if logger:
+        logger.error(msg, exc_info=exc_info)
+
+def log_warning(msg, logger=None, print_out=False):
+    if print_out:
+        print(msg)
+    if logger:
+        logger.warning(msg)
+
+
+def log_info(msg, logger=None, print_out=False):
+    if print_out:
+        print(msg)
+    if logger:
+        logger.info(msg)

{ipulse_shared_core_ftredge-2.8 → ipulse_shared_core_ftredge-2.8.1}/src/ipulse_shared_core_ftredge/models/__init__.py

@@ -1,7 +1,6 @@
 from .user_profile import UserProfile
 from .user_status import UserStatus
 from .user_profile_update import UserProfileUpdate
-from .organisation import Organisation
 from .user_auth import UserAuth
 
 

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/models/organisation.py

@@ -0,0 +1,71 @@
+# pylint: disable=missing-module-docstring
+# pylint: disable=missing-function-docstring
+# pylint: disable=missing-class-docstring
+# pylint: disable=broad-exception-caught
+# pylint: disable=line-too-long
+# pylint: disable=unused-variable
+# pylint: disable=broad-exception-caught
+# from pydantic import BaseModel, validator, ValidationError, Field
+# from typing import Set, Optional
+# import uuid
+# from datetime import datetime
+# import dateutil.parser
+
+# CLASS_VERSION= 1.0
+# MODULE= "core"
+# CLASS_REF="orgn"
+
+
+# class Organisation(BaseModel):
+#     puid: str = Field(default_factory=f"{datetime.utcnow().strftime('%Y%m%d%H%M')}{uuid.uuid4().hex[:8]}_{MODULE}{CLASS_REF}".lower())
+#     name: str
+#     creat_date: datetime = Field(default_factory=datetime.utcnow()) 
+#     updt_date: datetime = Field(default_factory=datetime.utcnow())
+#     creat_by_user: Optional[str] = None 
+#     updt_by_user: Optional[str] = None
+#     relations: Optional[Set[str]]=None
+#     description: Optional[str] = None  # Updated to use Optional
+#     industries: Optional[Set[str]] = None  # Updated to use Optional
+#     website: Optional[str] = None  # Updated to use Optional
+#     org_admin_user_uids: Optional[Set[str]] = None  # Updated to use Optional
+#     class Config:
+#             extra = "forbid"
+
+
+    # @validator('relations', pre=True, always=True)
+    # def validate_relations(cls, relations):
+    #     if not set(relations).issubset(enums.organisation_relations):
+    #         raise ValueError("Invalid relation values provided.")
+    #     return relations
+
+   
+    # @validator('industries', pre=True, always=True)
+    # def validate_industries(cls, industries):
+    #     if industries is not None and not set(industries).issubset(enums.organisation_industries):
+    #         raise ValueError("Invalid industry values provided.")
+    #     return industries
+    
+    # @validator('creat_date', 'updt_date', pre=True)
+    # def parse_date(cls, value):
+    #     if value is None:
+    #         return value
+    #     if isinstance(value, datetime):
+    #         return value
+    #     try:
+    #         # Assuming Firestore returns an ISO 8601 string, adjust if necessary
+    #         print("Putting Updt or Creat date in a valid format in a Validator when creating Organisation object")
+    #         return dateutil.parser.isoparse(value)
+    #     except (TypeError, ValueError):
+    #         raise ValidationError(f"Invalid datetime format inside Organisation: {value}")
+
+
+    # ### Description, Industries, and Website are optional for Retail Customer and mandatory for Non Retail Customer
+    # @validator('description', 'industries', 'website', pre=True, always=True)
+    # def validate_optional_fields(cls, value, values):
+    #     if values.get('name') == 'Retail Customer' and values.get('relations') == {"retail_customer"} or  values.get('relations') == ["retail_customer"]:
+    #         if value is not None:
+    #             raise ValueError("For 'Retail Customer' with only 'retail_customer' relations, description, industries, and website should not be provided.")
+    #     else:
+    #         if value is None:
+    #             raise ValueError("For Non Retail Customer, description, industries, and website are mandatory.")
+    #     return value

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/models/resource_catalog_item.py

@@ -0,0 +1,115 @@
+# import uuid
+# from datetime import datetime
+# from pydantic import BaseModel, validator, ValidationError
+# from typing import Dict, Any, Set, Optional
+
+# import dateutil.parser
+
+# CLASS_VERSION = 1.0
+# CLASS_REF = "resdes"
+# MODULE = "core"
+
+# class ResourceCatalogItem(BaseModel):
+
+#     resr_puid_or_name: str #Ex: username
+#     resr_path: str #Ex: ipulse-401013/cloud/firesotre/Users/{user_uid}/username
+#     resr_name: str #Ex: username
+#     resr_pulse_module: str  #Ex: core 
+#     resr_type: str
+#     resr_classifications: Set[str] 
+#     resr_contents:Set[str]
+#     resr_original_or_processed: str
+#     resr_origin: str
+#     resr_origin_organisations_uids: Set[str]
+#     resr_origin_description: str
+#     resr_licences_types: Set[str]
+#     resr_description_details: str 
+#     resr_updtbl_by_non_staff: bool
+#     resr_creat_by_user_uid: str
+#     resr_creat_date: datetime
+#     class_version:float = CLASS_VERSION
+#     resr_columns_count: int
+#     resr_columns: Optional[Dict[Any, Any]] = None #OPTIONAL
+#     resr_structure_version: Optional[str]=None # OPTIONAL
+#     resr_structure_updt_date: Optional[str]=None #OPTIONAL
+#     resr_structure_updt_by_user_uid: Optional[str]=None # OPTIONAL
+#     resr_tags: Optional[Dict[Any, Any]] = None #OPTIONAL
+#     resr_content_updt_date: Optional[str]=None #OPTIONAL
+#     resr_content_updt_by_user_uid: Optional[str]=None # OPTIONAL
+#     puid: Optional[str] = None #TO BE SETUP BY Validator
+#     metadata_version: Optional[float] = None #TO BE SETUP BY  Validator
+#     metadata_creat_date: Optional[datetime] = None #TO BE SETUP BY Management Service
+#     metadata_creat_by: Optional[str] = None #TO BE SETUP BY Management Service
+#     metadata_updt_date: Optional[datetime] = None #TO BE SETUP BY Management Service
+#     metadata_updt_by: Optional[str] = None #TO BE SETUP BY Management Service
+     
+    # @validator('puid', pre=True, always=True)
+    # def set_puid(cls, puid, values):
+    #     if puid is None:
+    #         return f"{datetime.utcnow().strftime('%Y%m%d%H%M')}{uuid.uuid4().hex[:8]}_{MODULE}{CLASS_REF}".lower()
+    #     return puid
+    
+    # @validator('metadata_version', pre=True, always=True)
+    # def set_metadata_version(cls, metadata_version, values):
+    #     if metadata_version is None:
+    #         return 1.0
+    #     else: 
+    #         return metadata_version + 0.1
+
+
+    # @validator('resr_pulse_module', pre=True, always=True)
+    # def validate_resr_pulse_module(cls, resr_pulse_modules):
+    #     if resr_pulse_modules not in enums.pulse_modules:
+    #         raise ValueError("Invalid pulse_modules values provided.")
+    #     return resr_pulse_modules
+    
+    # @validator('resr_type', pre=True, always=True)
+    # def validate_resr_type(cls, resr_type):
+    #     if  resr_type not in enums.resource_types:
+    #         raise ValueError("Invalid resource_types value provided.")
+    #     return resr_type
+    
+    # @validator('resr_classifications', pre=True, always=True)
+    # def validate_resr_classifications(cls, resr_classifications):
+    #     if not resr_classifications.issubset(enums.resource_classifications):
+    #         raise ValueError("Invalid resr_classifications values provided.")
+    #     return resr_classifications
+
+    # @validator('resr_contents', pre=True, always=True)
+    # def validate_resr_contents(cls, resr_contents):
+    #     if not resr_contents.issubset(enums.resource_contents):
+    #         raise ValueError("Invalid resr_contents values provided.")
+    #     return resr_contents
+
+    # @validator('resr_original_or_processed', pre=True, always=True)
+    # def validate_resr_original_or_processed(cls, resr_original_or_processed):
+    #     if  resr_original_or_processed not in enums.resource_original_or_processed:
+    #         raise ValueError("Invalid resr_original_or_processed value provided.")
+    #     return resr_original_or_processed
+    
+    # @validator('resr_origin', pre=True, always=True)
+    # def validate_resr_origin(cls, resr_origin):
+    #     if  resr_origin not in enums.resource_origins:
+    #         raise ValueError("Invalid resource_origins value provided.")
+    #     return resr_origin
+       
+
+    # @validator('metadata_creat_date', 'metadata_updt_date', pre=True)
+    # def parse_date(cls, value):
+    #     if value is None:
+    #         return value
+    #     if isinstance(value, datetime):
+    #         return value
+    #     try:
+    #         # Assuming Firestore returns an ISO 8601 string, adjust if necessary
+    #         return dateutil.parser.isoparse(value)
+    #     except (TypeError, ValueError):
+    #         raise ValidationError(f"Invalid datetime format inside Resource Description: {value}")
+
+
+    
+    # @validator('metadata_updt_date', 'metadata_updt_date', pre=True, always=True)
+    # def set_default_updt_date(cls, date, values):
+    #     if date is None:
+    #         return datetime.utcnow().isoformat()
+    #     return date

{ipulse_shared_core_ftredge-2.8 → ipulse_shared_core_ftredge-2.8.1}/src/ipulse_shared_core_ftredge/models/user_profile.py

@@ -11,12 +11,12 @@ CLASS_ORGIN_DATE=datetime(2024, 1, 16, 20, 5)
 CLASS_VERSION = 3.01
 CLASS_REVISION_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
 CLASS_REVISION_DATE=datetime(2024, 2, 13, 20, 15)
+LAST_MODIFICATION="Fixed typo"
+
 
 DOMAIN="user"
 OBJ_REF = "usprfl"
 
-
-
 class UserProfile(BaseModel):
     schema_version: float = Field(default=CLASS_VERSION, description="Version of this Class == version of DB Schema") #User can Read only
     # uid: str = Field(frozen=True, description="Combination of user_usrprof_<Firebase Auth UID>") #User can Read only ---> STORED as Firestore Doc ID
@@ -33,9 +33,9 @@ class UserProfile(BaseModel):
     provider_id: str   #User can Read only
     
     username: Optional[str] = None #User can Read and Edit
-    dob: Optional[date] = None #User can Read and Edit 
-    first_name: Optional[str] = None #User can Read and Edit 
-    last_name: Optional[str] = None #User can Read and Edit 
+    dob: Optional[date] = None #User can Read and Edit
+    first_name: Optional[str] = None #User can Read and Edit
+    last_name: Optional[str] = None #User can Read and Edit
     mobile: Optional[str] = None #User can Read and Edit
     class Config:
         extra = "forbid"

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/models/user_profile_update.py

@@ -0,0 +1,36 @@
+from typing import Optional, Set
+from pydantic import BaseModel, Field, EmailStr
+from datetime import date, datetime
+
+
+CLASS_ORIGIN_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
+CLASS_ORGIN_DATE=datetime(2024, 3, 15, 20, 15)
+
+CLASS_VERSION = 2.01
+CLASS_REVISION_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
+CLASS_REVISION_DATE=datetime(2024, 3, 15, 20, 15)
+LAST_MODIFICATION="Created , with all fields Optional"
+
+class UserProfileUpdate(BaseModel):
+    schema_version: Optional[float] = Field(None, description="Version of this Class == version of DB Schema")
+    email: Optional[EmailStr] = Field(None, description="Propagated from Firebase Auth")
+    organizations_uids: Optional[Set[str]] = Field(None, description="Depends on Subscription Plan, Regularly Updated")
+    creat_date: Optional[datetime] = Field(None, description="Creation date")
+    creat_by_user: Optional[str] = Field(None, description="Created by user")
+    updt_date: Optional[datetime] = Field(None, description="Update date")
+    updt_by_user: Optional[str] = Field(None, description="Updated by user")
+    aliases: Optional[Set[str]] = Field(None, description="User aliases")
+    provider_id: Optional[str] = Field(None, description="Provider ID")
+
+    username: Optional[str] = Field(None, description="Username")
+    dob: Optional[date] = Field(None, description="Date of Birth")
+    first_name: Optional[str] = Field(None, description="First Name")
+    last_name: Optional[str] = Field(None, description="Last Name")
+    mobile: Optional[str] = Field(None, description="Mobile Number")
+    
+    # def model_dump(self, **kwargs):
+    #         return super().model_dump(exclude_none=True, **kwargs)
+        
+        
+        
+        

{ipulse_shared_core_ftredge-2.8 → ipulse_shared_core_ftredge-2.8.1}/src/ipulse_shared_core_ftredge/models/user_status.py

@@ -1,42 +1,45 @@
 from pydantic import BaseModel, Field
+
 from datetime import datetime
 from dateutil.relativedelta import relativedelta
-from typing import Set, Optional
-# import uuid
-from . import pulse_enums as enums
+from typing import Set, Optional, Dict, List
+
+
 
 
 CLASS_ORIGIN_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
 CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
 
-CLASS_VERSION = 2.1
+SCHEMA_VERSION = 2.3
 CLASS_REVISION_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
 CLASS_REVISION_DATE=datetime(2024, 2, 13, 20, 15)
+LAST_MODIFICATION="Changed default IAM_GROUPS"
 
 DOMAIN="user"
 OBJ_REF = "usrsttus"
 
-DEFAULT_USER_GROUPS={"pulseroot__authuser_open"}
+DEFAULT_IAM_GROUPS={"pulseroot":["full_open_read"]}
 DEFAULT_SUBSCRIPTION_PLAN="subscription_free"
 DEFAULT_SUBSCRIPTION_STATUS="active"
-DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS=7
+DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS=10
 DEFAULT_EXTRA_INSIGHT_CREDITS=0
 
+############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
 class UserStatus(BaseModel):
-    schema_version: float = Field(default=CLASS_VERSION, description="Version of this Class == version of DB Schema") #User can Read only
+    schema_version: float = Field(default=SCHEMA_VERSION, description="Version of this Class == version of DB Schema") #User can Read only
     # uid: str = Field(frozen=True, description="Generated by Firebase Auth") #User can Read only
     # puid:str = Field(default_factory=lambda: f"{DOMAIN}{OBJ_REF}{datetime.utcnow().strftime('%Y%m%d%H%M')}{uuid.uuid4().hex[:8]}".lower(),
     #                   frozen=True, 
     #                   description="Generated Automatically by default_factory") #User can Read only
     
-    iam_groups: Set[str] = Field(default_factory=lambda:DEFAULT_USER_GROUPS, description="User's Groups, with a default one for all authenticated Pulse users") #User can Read only
+    iam_groups: Dict[str, List[str]] = Field(default_factory=lambda:DEFAULT_IAM_GROUPS, description="User's Groups, with a default one for all authenticated Pulse users") #User can Read only
     sbscrptn_plan: str=Field(default_factory=lambda:DEFAULT_SUBSCRIPTION_PLAN, description="Subscription Plan ") #User can Read only
     sbscrptn_status: str=Field(default_factory=lambda:DEFAULT_SUBSCRIPTION_STATUS, description="Subscription Status") #User can Read only
     sbscrptn_start_date: datetime=Field(default_factory=lambda:datetime.utcnow(), description="Subscription Start Date") #User can Read only
     sbscrptn_end_date: datetime=Field(default_factory=lambda:datetime.utcnow()+relativedelta(years=1) , description="Subscription End Date") #User can Read only
     sbscrptn_insight_credits: int= Field(default_factory=lambda:DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS, description="Depends on Subscription Plan, Set Amount udated at Regular Intervals or at Regular Time") #User can Read only
     sbscrptn_ins_crdts_updtd_since_datetime: datetime=Field(default_factory=lambda:datetime.utcnow(), description="Subscription Start Date") #User can Read only #User can Read only #User can Read only
-    extra_insigth_credits: int= Field(default_factory=lambda:DEFAULT_EXTRA_INSIGHT_CREDITS, description="If user purchased extra Insigth Credits they shouldn't Expire") #User can Read only
+    extra_insight_credits: int= Field(default_factory=lambda:DEFAULT_EXTRA_INSIGHT_CREDITS, description="If user purchased extra Insigth Credits they shouldn't Expire") #User can Read only
     payment_refs_uids: Optional[Set[str]] = None #User can Read only
     
     creat_date: datetime #User can Read only

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/utils/__init__.py

@@ -0,0 +1,3 @@
+# pylint: disable=missing-module-docstring
+
+from .utils_common import (list_as_strings)

ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge/utils/utils_common.py

@@ -0,0 +1,10 @@
+# pylint: disable=missing-module-docstring
+# pylint: disable=missing-function-docstring
+# pylint: disable=logging-fstring-interpolation
+# pylint: disable=line-too-long
+# pylint: disable=missing-class-docstring
+# pylint: disable=broad-exception-caught
+
+def list_as_strings(*enums):
+    """Converts a list of Enum members to their string values."""
+    return [str(enum) for enum in enums]

{ipulse_shared_core_ftredge-2.8 → ipulse_shared_core_ftredge-2.8.1/src/ipulse_shared_core_ftredge.egg-info}/PKG-INFO

@@ -1,10 +1,12 @@
 Metadata-Version: 2.1
 Name: ipulse_shared_core_ftredge
-Version: 2.8
-Summary: Shared models for the Pulse platform project. Using AI for financial advisory and investment management.
+Version: 2.8.1
+Summary: Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.
 Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
 Author: Russlan Ramdowar
 License-File: LICENCE
 Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: pytest~=7.1
+Requires-Dist: google-cloud-logging~=3.10.0
+Requires-Dist: google-cloud-error-reporting~=1.11.0

{ipulse_shared_core_ftredge-2.8 → ipulse_shared_core_ftredge-2.8.1}/src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt

@@ -8,14 +8,17 @@ src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt
 src/ipulse_shared_core_ftredge.egg-info/dependency_links.txt
 src/ipulse_shared_core_ftredge.egg-info/requires.txt
 src/ipulse_shared_core_ftredge.egg-info/top_level.txt
+src/ipulse_shared_core_ftredge/logging/__init__.py
+src/ipulse_shared_core_ftredge/logging/audit_log_firestore.py
+src/ipulse_shared_core_ftredge/logging/logging_handlers_and_formatters.py
+src/ipulse_shared_core_ftredge/logging/utils_logging.py
 src/ipulse_shared_core_ftredge/models/__init__.py
-src/ipulse_shared_core_ftredge/models/audit_log_firestore.py
 src/ipulse_shared_core_ftredge/models/organisation.py
-src/ipulse_shared_core_ftredge/models/pulse_enums.py
 src/ipulse_shared_core_ftredge/models/resource_catalog_item.py
 src/ipulse_shared_core_ftredge/models/user_auth.py
 src/ipulse_shared_core_ftredge/models/user_profile.py
 src/ipulse_shared_core_ftredge/models/user_profile_update.py
 src/ipulse_shared_core_ftredge/models/user_status.py
-src/ipulse_shared_core_ftredge/tests/__init__.py
-src/ipulse_shared_core_ftredge/tests/test.py
+src/ipulse_shared_core_ftredge/utils/__init__.py
+src/ipulse_shared_core_ftredge/utils/utils_common.py
+tests/test_utils_gcp.py