rgwfuncs 0.0.103__tar.gz → 0.0.107__tar.gz

{rgwfuncs-0.0.103/src/rgwfuncs.egg-info → rgwfuncs-0.0.107}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rgwfuncs
-Version: 0.0.103
+Version: 0.0.107
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfuncs
 Author: Ryan Gerard Wilson
@@ -24,6 +24,7 @@ Requires-Dist: requests
 Requires-Dist: slack-sdk
 Requires-Dist: google-api-python-client
 Requires-Dist: boto3
+Requires-Dist: pyfiglet
 Dynamic: license-file
 
 # RGWFUNCS

{rgwfuncs-0.0.103 → rgwfuncs-0.0.107}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rgwfuncs"
-version = "0.0.103"
+version = "0.0.107"
 authors = [
   { name = "Ryan Gerard Wilson", email = "ryangerardwilson@gmail.com" },
 ]
@@ -27,7 +27,8 @@ dependencies = [
     "requests",                  
     "slack-sdk",                 
     "google-api-python-client",  
-    "boto3"            
+    "boto3",           
+    "pyfiglet" 
 ]
 
 dynamic = ["scripts"]

{rgwfuncs-0.0.103 → rgwfuncs-0.0.107}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = rgwfuncs
-version = 0.0.103
+version = 0.0.107
 author = Ryan Gerard Wilson
 author_email = ryangerardwilson@gmail.com
 description = A functional programming paradigm for mathematical modelling and data science
@@ -29,6 +29,7 @@ install_requires =
 	slack-sdk
 	google-api-python-client
 	boto3
+	pyfiglet
 
 [options.packages.find]
 where = src

{rgwfuncs-0.0.103 → rgwfuncs-0.0.107}/src/rgwfuncs/__init__.py

@@ -4,4 +4,4 @@
 from .df_lib import append_columns, append_percentile_classification_column, append_ranged_classification_column, append_ranged_date_classification_column, append_rows, append_xgb_labels, append_xgb_logistic_regression_predictions, append_xgb_regression_predictions, bag_union_join, bottom_n_unique_values, cascade_sort, delete_rows, drop_duplicates, drop_duplicates_retain_first, drop_duplicates_retain_last, filter_dataframe, filter_indian_mobiles, first_n_rows, from_raw_data, insert_dataframe_in_sqlite_database, last_n_rows, left_join, limit_dataframe, load_data_from_path, load_data_from_query, load_data_from_sqlite_path, load_fresh_data_or_pull_from_cache, mask_against_dataframe, mask_against_dataframe_converse, numeric_clean, order_columns, print_correlation, print_dataframe, print_memory_usage, print_n_frequency_cascading, print_n_frequency_linear, rename_columns, retain_columns, right_join, send_data_to_email, send_data_to_slack, send_dataframe_via_telegram, sync_dataframe_to_sqlite_database, top_n_unique_values, union_join, update_rows
 from .interactive_shell_lib import interactive_shell
 from .docs_lib import docs
-from .str_lib import send_telegram_message
+from .str_lib import heading, send_telegram_message, sub_heading, title

rgwfuncs-0.0.107/src/rgwfuncs/str_lib.py

@@ -0,0 +1,276 @@
+import sys
+import time
+import os
+import json
+import requests
+from typing import Tuple, Optional, Union, Dict
+from collections import defaultdict
+import warnings
+from pyfiglet import Figlet
+from datetime import datetime
+
+# Suppress all FutureWarnings
+warnings.filterwarnings("ignore", category=FutureWarning)
+
+# Module-level variables
+_PRINT_HEADING_CURRENT_CALL = 0
+_PRINT_SUBHEADING_COUNTS = defaultdict(int)  # Tracks sub-headings per heading
+_CURRENT_HEADING_NUMBER = 0
+
+def send_telegram_message(preset_name: str, message: str, config: Optional[Union[str, dict]] = None) -> None:
+    """
+    Send a Telegram message using the specified preset.
+
+    Args:
+        preset_name (str): The name of the preset to use for sending the message.
+        message (str): The message to send.
+        config (Optional[Union[str, dict]], optional): Configuration source. Can be:
+          - None: Searches for '.rgwfuncsrc' in current directory and upwards
+          - str: Path to a JSON configuration file
+          - dict: Direct configuration dictionary
+
+    Raises:
+        FileNotFoundError: If no '.rgwfuncsrc' file is found in current or parent directories.
+        ValueError: If the config parameter is neither a path string nor a dictionary, or if the config file is empty/invalid.
+        RuntimeError: If the preset is not found or necessary details are missing.
+    """
+    def get_config(config: Optional[Union[str, dict]] = None) -> dict:
+        """Get configuration either from a path, direct dictionary, or by searching upwards."""
+        def get_config_from_file(config_path: str) -> dict:
+            """Load configuration from a JSON file."""
+            # print(f"Reading config from: {config_path}")  # Debug line
+            with open(config_path, 'r', encoding='utf-8') as file:
+                content = file.read()
+                # print(f"Config content (first 100 chars): {content[:100]}...")  # Debug line
+                if not content.strip():
+                    raise ValueError(f"Config file {config_path} is empty")
+                try:
+                    return json.loads(content)
+                except json.JSONDecodeError as e:
+                    raise ValueError(f"Invalid JSON in config file {config_path}: {e}")
+
+        def find_config_file() -> str:
+            """Search for '.rgwfuncsrc' in current directory and upwards."""
+            current_dir = os.getcwd()
+            # print(f"Starting config search from: {current_dir}")  # Debug line
+            while True:
+                config_path = os.path.join(current_dir, '.rgwfuncsrc')
+                # print(f"Checking for config at: {config_path}")  # Debug line
+                if os.path.isfile(config_path):
+                    # print(f"Found config at: {config_path}")  # Debug line
+                    return config_path
+                parent_dir = os.path.dirname(current_dir)
+                if parent_dir == current_dir:  # Reached root directory
+                    raise FileNotFoundError(f"No '.rgwfuncsrc' file found in {os.getcwd()} or parent directories")
+                current_dir = parent_dir
+
+        # Determine the config to use
+        if config is None:
+            # Search for .rgwfuncsrc upwards from current directory
+            config_path = find_config_file()
+            return get_config_from_file(config_path)
+        elif isinstance(config, str):
+            # If config is a string, treat it as a path and load it
+            return get_config_from_file(config)
+        elif isinstance(config, dict):
+            # If config is already a dict, use it directly
+            return config
+        else:
+            raise ValueError("Config must be either a path string or a dictionary")
+
+    def get_telegram_preset(config: dict, preset_name: str) -> dict:
+        """Get the Telegram preset configuration."""
+        presets = config.get("telegram_bot_presets", [])
+        for preset in presets:
+            if preset.get("name") == preset_name:
+                return preset
+        return None
+
+    def get_telegram_bot_details(config: dict, preset_name: str) -> Tuple[str, str]:
+        """Retrieve the Telegram bot token and chat ID from the preset."""
+        preset = get_telegram_preset(config, preset_name)
+        if not preset:
+            raise RuntimeError(
+                f"Telegram bot preset '{preset_name}' not found in the configuration file")
+
+        bot_token = preset.get("bot_token")
+        chat_id = preset.get("chat_id")
+
+        if not bot_token or not chat_id:
+            raise RuntimeError(
+                f"Telegram bot token or chat ID for '{preset_name}' not found in the configuration file")
+
+        return bot_token, chat_id
+
+    config = get_config(config)
+    # Get bot details from the configuration
+    bot_token, chat_id = get_telegram_bot_details(config, preset_name)
+
+    # Prepare the request
+    url = f"https://api.telegram.org/bot{bot_token}/sendMessage"
+    payload = {"chat_id": chat_id, "text": message}
+
+    # Send the message
+    response = requests.post(url, json=payload)
+    response.raise_for_status()
+
+def title(text: str, font: str = "slant", typing_speed: float = 0.005) -> None:
+    """
+    Print text as ASCII art with a typewriter effect using the specified font (default: slant),
+    indented by 4 spaces. All output, including errors and separators, is printed with the
+    typewriter effect within this function.
+
+    Args:
+        text (str): The text to convert to ASCII art.
+        font (str, optional): The pyfiglet font to use. Defaults to "slant".
+        typing_speed (float, optional): Delay between printing each character in seconds.
+                                      Defaults to 0.005.
+
+    Raises:
+        ValueError: If the specified font is invalid or unavailable.
+        RuntimeError: If there is an error generating the ASCII art.
+    """
+    # ANSI color codes
+    heading_color = '\033[92m'  # Bright green for headings
+    reset_color = '\033[0m'     # Reset to default
+
+    try:
+        # Initialize Figlet with the specified font
+        figlet = Figlet(font=font)
+        # Generate ASCII art
+        ascii_art = figlet.renderText(text)
+        # Indent each line by 4 spaces
+        indented_ascii_art = '\n'.join('    ' + line for line in ascii_art.splitlines())
+
+        # Print ASCII art with typewriter effect
+        print(heading_color, end='')
+        for char in indented_ascii_art + '\n':
+            print(char, end='', flush=True)
+            if char != '\n':  # Don't delay on newlines
+                time.sleep(typing_speed)
+        print(reset_color, end='')
+
+        # Print separator line with typewriter effect
+        print(heading_color, end='')
+        for char in '=' * 79 + '\n':
+            print(char, end='', flush=True)
+            if char != '\n':
+                time.sleep(typing_speed)
+        print(reset_color, end='')
+
+    except Exception as e:
+        error_msg = ''
+        if "font" in str(e).lower():
+            error_msg = f"Invalid or unavailable font: {font}. Ensure the font is supported by pyfiglet.\n"
+            print(reset_color, end='')
+            for char in error_msg:
+                print(char, end='', flush=True)
+                if char != '\n':
+                    time.sleep(typing_speed)
+            raise ValueError(error_msg)
+        error_msg = f"Error generating ASCII art for \"{text}\" with font {font}: {e}\n"
+        print(reset_color, end='')
+        for char in error_msg:
+            print(char, end='', flush=True)
+            if char != '\n':
+                time.sleep(typing_speed)
+        raise RuntimeError(error_msg)
+
+def heading(text: str, typing_speed: float = 0.002) -> None:
+    """
+    Print a heading with the specified text in uppercase,
+    formatted as '[current_call] TEXT' with a timestamp and typewriter effect.
+    Ensures the formatted heading is <= 50 characters and total line is 79 characters.
+    Adds empty lines before and after the heading.
+
+    Args:
+        text (str): The heading text to print.
+        typing_speed (float, optional): Delay between printing each character in seconds.
+                                      Defaults to 0.005.
+    """
+    global _PRINT_HEADING_CURRENT_CALL, _CURRENT_HEADING_NUMBER, _PRINT_SUBHEADING_COUNTS
+
+    # Increment heading call
+    _PRINT_HEADING_CURRENT_CALL += 1
+    _CURRENT_HEADING_NUMBER = _PRINT_HEADING_CURRENT_CALL
+    _PRINT_SUBHEADING_COUNTS[_CURRENT_HEADING_NUMBER] = 0  # Reset sub-heading count
+
+    # ANSI color codes
+    color = '\033[92m'  # Bright green for headings
+    reset_color = '\033[0m'
+
+    # Format heading
+    prefix = f"[{_PRINT_HEADING_CURRENT_CALL}] "
+    max_text_length = 50 - len(prefix)
+    formatted_text = text.upper()[:max_text_length]
+    heading = f"{prefix}{formatted_text}"
+
+    # Get timestamp
+    timestamp = f"[{datetime.now().strftime('%Y-%m-%d %H:%M:%S')}]"
+
+    # Calculate padding
+    padding_length = 79 - len(heading) - 1 - len(timestamp) - 1  # Spaces before padding and timestamp
+    padding = '=' * padding_length if padding_length > 0 else ''
+    full_line = f"{heading} {padding} {timestamp}"
+
+    # Print with line breaks and typewriter effect
+    print()  # Empty line before
+    print(color, end='')
+    for char in full_line + '\n':
+        print(char, end='', flush=True)
+        if char != '\n':
+            time.sleep(typing_speed)
+    print(reset_color, end='')
+    print()  # Empty line after
+
+def sub_heading(text: str, typing_speed: float = 0.002) -> None:
+    """
+    Print a sub-heading under the most recent heading, formatted as
+    '[heading_num.sub_heading_num] TEXT' with a timestamp and typewriter effect.
+    Ensures the formatted sub-heading is <= 50 characters and total line is 79 characters.
+    Adds empty lines before and after the sub-heading.
+
+    Args:
+        text (str): The sub-heading text to print.
+        typing_speed (float, optional): Delay between printing each character in seconds.
+                                      Defaults to 0.005.
+
+    Raises:
+        ValueError: If no heading has been called.
+    """
+    global _PRINT_SUBHEADING_COUNTS, _CURRENT_HEADING_NUMBER
+
+    if _CURRENT_HEADING_NUMBER == 0:
+        raise ValueError("No heading called before sub_heading.")
+
+    # Increment sub-heading count
+    _PRINT_SUBHEADING_COUNTS[_CURRENT_HEADING_NUMBER] += 1
+    current_sub = _PRINT_SUBHEADING_COUNTS[_CURRENT_HEADING_NUMBER]
+
+    # ANSI color codes
+    color = '\033[92m'  # Bright green for sub-headings
+    reset_color = '\033[0m'
+
+    # Format sub-heading
+    prefix = f"[{_CURRENT_HEADING_NUMBER}.{current_sub}] "
+    max_text_length = 50 - len(prefix)
+    formatted_text = text.lower()[:max_text_length]
+    sub_heading = f"{prefix}{formatted_text}"
+
+    # Get timestamp
+    timestamp = f"[{datetime.now().strftime('%Y-%m-%d %H:%M:%S')}]"
+
+    # Calculate padding
+    padding_length = 79 - len(sub_heading) - 1 - len(timestamp) - 1  # Spaces before padding and timestamp
+    padding = '-' * padding_length if padding_length > 0 else ''
+    full_line = f"{sub_heading} {padding} {timestamp}"
+
+    # Print with line breaks and typewriter effect
+    print()  # Empty line before
+    print(color, end='')
+    for char in full_line + '\n':
+        print(char, end='', flush=True)
+        if char != '\n':
+            time.sleep(typing_speed)
+    print(reset_color, end='')
+    print()  # Empty line after

{rgwfuncs-0.0.103 → rgwfuncs-0.0.107/src/rgwfuncs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rgwfuncs
-Version: 0.0.103
+Version: 0.0.107
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfuncs
 Author: Ryan Gerard Wilson
@@ -24,6 +24,7 @@ Requires-Dist: requests
 Requires-Dist: slack-sdk
 Requires-Dist: google-api-python-client
 Requires-Dist: boto3
+Requires-Dist: pyfiglet
 Dynamic: license-file
 
 # RGWFUNCS

{rgwfuncs-0.0.103 → rgwfuncs-0.0.107}/src/rgwfuncs.egg-info/requires.txt

@@ -9,3 +9,4 @@ requests
 slack-sdk
 google-api-python-client
 boto3
+pyfiglet

rgwfuncs-0.0.103/src/rgwfuncs/str_lib.py

@@ -1,106 +0,0 @@
-import os
-import json
-import requests
-from typing import Tuple, Optional, Union, Dict
-import warnings
-
-# Suppress all FutureWarnings
-warnings.filterwarnings("ignore", category=FutureWarning)
-
-
-def send_telegram_message(preset_name: str, message: str, config: Optional[Union[str, dict]] = None) -> None:
-    """
-    Send a Telegram message using the specified preset.
-
-    Args:
-        preset_name (str): The name of the preset to use for sending the message.
-        message (str): The message to send.
-        config (Optional[Union[str, dict]], optional): Configuration source. Can be:
-          - None: Searches for '.rgwfuncsrc' in current directory and upwards
-          - str: Path to a JSON configuration file
-          - dict: Direct configuration dictionary
-
-    Raises:
-        FileNotFoundError: If no '.rgwfuncsrc' file is found in current or parent directories.
-        ValueError: If the config parameter is neither a path string nor a dictionary, or if the config file is empty/invalid.
-        RuntimeError: If the preset is not found or necessary details are missing.
-    """
-    def get_config(config: Optional[Union[str, dict]] = None) -> dict:
-        """Get configuration either from a path, direct dictionary, or by searching upwards."""
-        def get_config_from_file(config_path: str) -> dict:
-            """Load configuration from a JSON file."""
-            # print(f"Reading config from: {config_path}")  # Debug line
-            with open(config_path, 'r', encoding='utf-8') as file:
-                content = file.read()
-                # print(f"Config content (first 100 chars): {content[:100]}...")  # Debug line
-                if not content.strip():
-                    raise ValueError(f"Config file {config_path} is empty")
-                try:
-                    return json.loads(content)
-                except json.JSONDecodeError as e:
-                    raise ValueError(f"Invalid JSON in config file {config_path}: {e}")
-
-        def find_config_file() -> str:
-            """Search for '.rgwfuncsrc' in current directory and upwards."""
-            current_dir = os.getcwd()
-            # print(f"Starting config search from: {current_dir}")  # Debug line
-            while True:
-                config_path = os.path.join(current_dir, '.rgwfuncsrc')
-                # print(f"Checking for config at: {config_path}")  # Debug line
-                if os.path.isfile(config_path):
-                    # print(f"Found config at: {config_path}")  # Debug line
-                    return config_path
-                parent_dir = os.path.dirname(current_dir)
-                if parent_dir == current_dir:  # Reached root directory
-                    raise FileNotFoundError(f"No '.rgwfuncsrc' file found in {os.getcwd()} or parent directories")
-                current_dir = parent_dir
-
-        # Determine the config to use
-        if config is None:
-            # Search for .rgwfuncsrc upwards from current directory
-            config_path = find_config_file()
-            return get_config_from_file(config_path)
-        elif isinstance(config, str):
-            # If config is a string, treat it as a path and load it
-            return get_config_from_file(config)
-        elif isinstance(config, dict):
-            # If config is already a dict, use it directly
-            return config
-        else:
-            raise ValueError("Config must be either a path string or a dictionary")
-
-    def get_telegram_preset(config: dict, preset_name: str) -> dict:
-        """Get the Telegram preset configuration."""
-        presets = config.get("telegram_bot_presets", [])
-        for preset in presets:
-            if preset.get("name") == preset_name:
-                return preset
-        return None
-
-    def get_telegram_bot_details(config: dict, preset_name: str) -> Tuple[str, str]:
-        """Retrieve the Telegram bot token and chat ID from the preset."""
-        preset = get_telegram_preset(config, preset_name)
-        if not preset:
-            raise RuntimeError(
-                f"Telegram bot preset '{preset_name}' not found in the configuration file")
-
-        bot_token = preset.get("bot_token")
-        chat_id = preset.get("chat_id")
-
-        if not bot_token or not chat_id:
-            raise RuntimeError(
-                f"Telegram bot token or chat ID for '{preset_name}' not found in the configuration file")
-
-        return bot_token, chat_id
-
-    config = get_config(config)
-    # Get bot details from the configuration
-    bot_token, chat_id = get_telegram_bot_details(config, preset_name)
-
-    # Prepare the request
-    url = f"https://api.telegram.org/bot{bot_token}/sendMessage"
-    payload = {"chat_id": chat_id, "text": message}
-
-    # Send the message
-    response = requests.post(url, json=payload)
-    response.raise_for_status()