chameli 0.1.1__tar.gz

chameli-0.1.1/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: chameli
+Version: 0.1.1
+Summary: A lightweight Python library for python utilities for holidays, dates, options and other tools
+Author-email: Pankaj Sharma <sharma.pankaj.kumar@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://bitbucket.org/incurrency/chameli
+Project-URL: repository, https://bitbucket.org/incurrency/chameli
+Description-Content-Type: text/markdown
+Requires-Dist: numpy==1.26.4
+Requires-Dist: pandas==2.2.3
+Requires-Dist: scikit-learn==1.5.0
+Requires-Dist: scipy==1.11.4
+Requires-Dist: pyyaml==6.0
+Requires-Dist: pyreadr==0.5.0
+Requires-Dist: rpy2==3.5.16
+Requires-Dist: pytz==2024.1
+Requires-Dist: selenium==4.0.0
+Requires-Dist: requests==2.32.3
+Requires-Dist: psutil==7.0.0
+Requires-Dist: scp==0.15.0
+Requires-Dist: paramiko==3.5.1
+
+# coreutils
+
+coreutils is a lightweight Python library providing utilities for working with holidays, dates, options, and other trading-related tools. It is designed to simplify common tasks in quantitative finance and trading workflows.
+
+---
+
+## Features
+
+- **Date Utilities**: Simplify date and time operations.
+- **Options Pricing**: Tools for European options calculations.
+- **External Interactions**: Functions for assisting web scraping, reading and writing R files.
+- **Config Management**: Centralized configuration management using YAML files.
+
+---
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install coreutils
+```
+
+---
+
+## Functions Overview
+
+Below is a list of available functions in each module. For detailed usage, use the `help(function_name)` command in Python.
+
+### `dateutils` Module
+- `load_holidays_by_exchange()`
+- `valid_datetime(sdatetime, out_pattern=None)`
+- `is_business_day(date, exchange="NSE")`
+- `business_days_between(start_date, end_date, include_first=False, include_last=False, exchange="NSE")`
+- `calc_fractional_business_days(start_datetime, end_datetime, exchange="NSE")`
+- `advance_by_biz_days(datetime_, days, adjustment="fbd", exchange="NSE")`
+- `get_last_day_of_month(year, month)`
+- `get_expiry(date, weekly=0, day_of_week=4, exchange="NSE")`
+- `is_aware(datetime_)`
+- `get_aware_dt(datetime_, tz="Asia/Kolkata")`
+- `get_naive_dt(datetime_)`
+- `is_time_between(begin_time, end_time, check_time)`
+
+### `europeanoptions` Module
+- `BlackScholesPrice(S, X, r, sigma, T, OptionType)`
+- `BlackScholesDelta(S, X, r, sigma, T, OptionType)`
+- `BlackScholesGamma(S, X, r, sigma, T)`
+- `BlackScholesVega(S, X, r, sigma, T)`
+- `BlackScholesTheta(S, X, r, sigma, T, OptionType, daysInYear=252)`
+- `BlackScholesIV(S, X, r, T, OptionType, OptionPrice, seed=0.2)`
+- `calc_delta(long_symbol, opt_price, underlying, time, days_in_year=252, risk_free_rate=0, exchange="NSE")`
+- `get_option_price(long_symbol, S, sigma, calc_time, r=0, days_in_year=252, exchange="NSE")`
+- `calc_greeks(long_symbol, opt_price, underlying, calc_time, greeks, days_in_year=252, risk_free_rate=0, exchange="NSE")`
+- `generate_opt_simulation(symbols, quantities, target_date, vol_shift, start_range, end_range, increment, market_data, exchange="NSE")`
+- `find_x_intercepts(price, value)`
+
+### `interactions` Module
+- `readRDS(filename)`
+- `saveRDS(pd_file, path)`
+- `send_mail(send_from, send_to, password, subject, text, files=None, is_html=False)`
+- `get_session_or_driver(url_to_test, get_session=True, headless=False, desktop_session=4, proxy_source=None, api_key=None, proxy_user=None, proxy_password=None, country_code=None, webdriver_path=None)`
+
+### `miscutils` Module
+- `convert_to_dot_dict(dictionary)`
+- `np_ffill(arr, axis=0)`
+
+---

chameli-0.1.1/README.md

@@ -0,0 +1,67 @@
+# coreutils
+
+coreutils is a lightweight Python library providing utilities for working with holidays, dates, options, and other trading-related tools. It is designed to simplify common tasks in quantitative finance and trading workflows.
+
+---
+
+## Features
+
+- **Date Utilities**: Simplify date and time operations.
+- **Options Pricing**: Tools for European options calculations.
+- **External Interactions**: Functions for assisting web scraping, reading and writing R files.
+- **Config Management**: Centralized configuration management using YAML files.
+
+---
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install coreutils
+```
+
+---
+
+## Functions Overview
+
+Below is a list of available functions in each module. For detailed usage, use the `help(function_name)` command in Python.
+
+### `dateutils` Module
+- `load_holidays_by_exchange()`
+- `valid_datetime(sdatetime, out_pattern=None)`
+- `is_business_day(date, exchange="NSE")`
+- `business_days_between(start_date, end_date, include_first=False, include_last=False, exchange="NSE")`
+- `calc_fractional_business_days(start_datetime, end_datetime, exchange="NSE")`
+- `advance_by_biz_days(datetime_, days, adjustment="fbd", exchange="NSE")`
+- `get_last_day_of_month(year, month)`
+- `get_expiry(date, weekly=0, day_of_week=4, exchange="NSE")`
+- `is_aware(datetime_)`
+- `get_aware_dt(datetime_, tz="Asia/Kolkata")`
+- `get_naive_dt(datetime_)`
+- `is_time_between(begin_time, end_time, check_time)`
+
+### `europeanoptions` Module
+- `BlackScholesPrice(S, X, r, sigma, T, OptionType)`
+- `BlackScholesDelta(S, X, r, sigma, T, OptionType)`
+- `BlackScholesGamma(S, X, r, sigma, T)`
+- `BlackScholesVega(S, X, r, sigma, T)`
+- `BlackScholesTheta(S, X, r, sigma, T, OptionType, daysInYear=252)`
+- `BlackScholesIV(S, X, r, T, OptionType, OptionPrice, seed=0.2)`
+- `calc_delta(long_symbol, opt_price, underlying, time, days_in_year=252, risk_free_rate=0, exchange="NSE")`
+- `get_option_price(long_symbol, S, sigma, calc_time, r=0, days_in_year=252, exchange="NSE")`
+- `calc_greeks(long_symbol, opt_price, underlying, calc_time, greeks, days_in_year=252, risk_free_rate=0, exchange="NSE")`
+- `generate_opt_simulation(symbols, quantities, target_date, vol_shift, start_range, end_range, increment, market_data, exchange="NSE")`
+- `find_x_intercepts(price, value)`
+
+### `interactions` Module
+- `readRDS(filename)`
+- `saveRDS(pd_file, path)`
+- `send_mail(send_from, send_to, password, subject, text, files=None, is_html=False)`
+- `get_session_or_driver(url_to_test, get_session=True, headless=False, desktop_session=4, proxy_source=None, api_key=None, proxy_user=None, proxy_password=None, country_code=None, webdriver_path=None)`
+
+### `miscutils` Module
+- `convert_to_dot_dict(dictionary)`
+- `np_ffill(arr, axis=0)`
+
+---

chameli-0.1.1/chameli/__init__.py

@@ -0,0 +1,145 @@
+import logging
+import os
+import sys
+from importlib.resources import files
+from logging.handlers import TimedRotatingFileHandler
+
+__version__ = "0.1.9dev3"
+
+from .config import is_config_loaded, load_config
+
+# Ensure the module's directory is in the system path
+sys.path.append(os.path.dirname(os.path.realpath(__file__)))
+
+
+def get_default_config_path():
+    """Returns the path to the default config file included in the package."""
+    try:
+        return files("chameli").joinpath("config/config_sample.yaml")
+    except FileNotFoundError:
+        # Fallback to relative path in the source directory
+        return os.path.join(os.path.dirname(__file__), "config/config_sample.yaml")
+
+
+def configure_logging(
+    module_names=None,
+    level=logging.WARNING,
+    log_file=None,
+    clear_existing_handlers=False,
+    enable_console=True,
+    backup_count=7,
+):
+    """
+    Configure logging for specific or all modules in the pyTrade package.
+
+    Args:
+        module_names (list of str): List of module names to enable logging for.
+        level (int): Logging level (e.g., logging.DEBUG, logging.INFO).
+        log_file (str): Path to the log file. If None, logs will go to console.
+        clear_existing_handlers (bool): Whether to clear existing handlers.
+        enable_console (bool): Whether console logging is enabled.
+        backup_count (int): Number of log files to keep.
+    """
+    if clear_existing_handlers:
+        for handler in logging.root.handlers[:]:
+            logging.root.removeHandler(handler)
+
+    # Create handlers
+    handlers = []
+    formatter = logging.Formatter("%(asctime)s:%(filename)s:%(lineno)s - %(funcName)20s() ] %(message)s")
+    if log_file:
+        file_handler = TimedRotatingFileHandler(log_file, when="midnight", backupCount=backup_count)
+        file_handler.suffix = "%Y%m%d"
+        file_handler.setLevel(level)
+        file_handler.setFormatter(formatter)
+        handlers.append(file_handler)
+
+    if enable_console:
+        console_handler = logging.StreamHandler()
+        console_handler.setLevel(level)
+        console_handler.setFormatter(formatter)
+        handlers.append(console_handler)
+
+    # Configure logging for specific modules or globally
+    if module_names:
+        for module_name in module_names:
+            logger = logging.getLogger(module_name)
+            logger.setLevel(level)
+            for handler in handlers:
+                logger.addHandler(handler)
+    else:
+        # Configure root logger if no specific modules are mentioned
+        root_logger = logging.getLogger()
+        root_logger.setLevel(level)
+        for handler in handlers:
+            root_logger.addHandler(handler)
+
+
+# Set default logging level to WARNING and log to console by default
+configure_logging()
+
+
+def initialize_config(config_file_path: str, force_reload=True):
+    """
+    Initializes the configuration from the specified file.
+
+    Args:
+        config_file_path (str): Path to the configuration file.
+        force_reload (bool): Whether to force reload the configuration.
+
+    Raises:
+        RuntimeError: If the configuration is already loaded
+        and force_reload is False.
+    """
+    if is_config_loaded() and not force_reload:
+        raise RuntimeError("Configuration is already loaded.")
+    else:
+        load_config(config_file_path)
+
+
+# Initialize configuration with the default config path
+initialize_config(get_default_config_path())
+
+
+class LazyModule:
+    """
+    Lazily loads a module when an attribute is accessed.
+
+    Args:
+        module_name (str): The name of the module to load.
+    """
+
+    def __init__(self, module_name):
+        self.module_name = module_name
+        self.module = None
+
+    def _load_module(self):
+        allowed_modules = [
+            "chameli.dateutils",
+            "chameli.europeanoptions",
+            "chameli.interactions",
+        ]
+        if self.module_name not in allowed_modules:
+            raise ImportError(f"Module {self.module_name} is not allowed.")
+        if not self.module:
+            if not is_config_loaded():
+                raise RuntimeError("Configuration not loaded. Call `initialize_config` first.")
+            self.module = __import__(self.module_name, fromlist=[""])
+
+    def __getattr__(self, name):
+        self._load_module()
+        return getattr(self.module, name)
+
+
+# Lazy loading for modules
+dateutils = LazyModule("chameli.dateutils")
+europeanoptions = LazyModule("chameli.europeanoptions")
+interactions = LazyModule("chameli.interactions")
+
+__all__ = [
+    "dateutils",
+    "europeanoptions",
+    "interactions",
+    "initialize_config",
+    "configure_logging",
+]