Update: Added Docstrings, Type Annotations, Logger Setup, New Examples, and README Update

.gitignore

@@ -4,4 +4,7 @@
 .idea/smartapi-python.iml
 build/*
 smartapi_python.egg-info
-dist/*
+dist/*
+
+*.pyc
+__pycache__

SmartApi/__init__.py

@@ -1,10 +1,9 @@
 from __future__ import unicode_literals,absolute_import
 
 from SmartApi.smartConnect import SmartConnect
-# from SmartApi.webSocket import WebSocket
-from SmartApi.smartApiWebsocket import SmartWebSocket
+from SmartApi.smartWebSocketV2 import SmartWebSocketV2
 
-__all__ = ["SmartConnect","SmartWebSocket"]
+__all__ = ["SmartConnect", "SmartWebSocketV2"]
 
 
 

SmartApi/loggerConfig.py

@@ -0,0 +1,44 @@
+import logging
+import os
+
+LOG_DIR = "logs"
+LOG_FILE = "app.log"
+
+# Ensure the log directory exists
+os.makedirs(LOG_DIR, exist_ok=True)
+
+def get_logger(name: str, level: str = "WARNING") -> logging.Logger:
+    """
+    Creates and returns a logger instance that logs messages at the specified level and above.
+    Logs are saved in logs/app.log and also printed to console.
+
+    Parameters:
+        name (str): Logger name.
+        level (str): Logging level (e.g. 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL').
+                     Defaults to 'WARNING'.
+
+    Returns:
+        logging.Logger: Configured logger instance.
+    """
+
+    logger = logging.getLogger(name)
+    logger.setLevel(getattr(logging, level.upper(), logging.WARNING))
+
+    if not logger.hasHandlers():
+        # File handler
+        log_path = os.path.join(LOG_DIR, LOG_FILE)
+        file_handler = logging.FileHandler(log_path)
+        file_handler.setLevel(getattr(logging, level.upper(), logging.WARNING))
+
+        # Console handler
+        console_handler = logging.StreamHandler()
+        console_handler.setLevel(getattr(logging, level.upper(), logging.WARNING))
+
+        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+        file_handler.setFormatter(formatter)
+        console_handler.setFormatter(formatter)
+
+        logger.addHandler(file_handler)
+        logger.addHandler(console_handler)
+
+    return logger