rgwfuncs 0.0.103__py3-none-any.whl → 0.0.107__py3-none-any.whl

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/str_lib.py

@@ -1,12 +1,21 @@
+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:
     """
@@ -104,3 +113,164 @@ def send_telegram_message(preset_name: str, message: str, config: Optional[Union
     # 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.dist-info → rgwfuncs-0.0.107.dist-info}/METADATA

@@ -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.107.dist-info/RECORD

@@ -0,0 +1,11 @@
+rgwfuncs/__init__.py,sha256=XIbMHeEimBLNcX2PK7uQGquG-eAYXsetVEJrlBZIH5U,1295
+rgwfuncs/df_lib.py,sha256=3foomRHlunCpf_accTcqfdgwDmSPIVkVCnlWJ4ag4XQ,76947
+rgwfuncs/docs_lib.py,sha256=i63NzX-V8cGhikYdtkRGAEe2VcuwpXxDUyTRa9xI7l8,1972
+rgwfuncs/interactive_shell_lib.py,sha256=YeJBW9YgH5Nv77ONdOyIKFgtf0ItXStdlKGN9GGf8bU,4228
+rgwfuncs/str_lib.py,sha256=xjdD-NJcb5YPKIDnJFItXIUXlTmjX1Kg3lci8eqvfQs,11391
+rgwfuncs-0.0.107.dist-info/licenses/LICENSE,sha256=jLvt20gcUZYB8UOvyBvyKQ1qhYYhD__qP7ZDx2lPFkU,1062
+rgwfuncs-0.0.107.dist-info/METADATA,sha256=1yKapK7_SsGrpRCAqxnDap4zpoUQ9cz8DbUTLMcCx7g,42972
+rgwfuncs-0.0.107.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rgwfuncs-0.0.107.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
+rgwfuncs-0.0.107.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
+rgwfuncs-0.0.107.dist-info/RECORD,,

rgwfuncs-0.0.103.dist-info/RECORD

@@ -1,11 +0,0 @@
-rgwfuncs/__init__.py,sha256=ULY2H_0hLkp4sEdeZnlSJujb6-nZIeZGrBUWeQTZX4A,1266
-rgwfuncs/df_lib.py,sha256=3foomRHlunCpf_accTcqfdgwDmSPIVkVCnlWJ4ag4XQ,76947
-rgwfuncs/docs_lib.py,sha256=i63NzX-V8cGhikYdtkRGAEe2VcuwpXxDUyTRa9xI7l8,1972
-rgwfuncs/interactive_shell_lib.py,sha256=YeJBW9YgH5Nv77ONdOyIKFgtf0ItXStdlKGN9GGf8bU,4228
-rgwfuncs/str_lib.py,sha256=qpt7jPbQ2Feu88zt3_7L8w5jMsBGacBS74Sa5om4VLE,4814
-rgwfuncs-0.0.103.dist-info/licenses/LICENSE,sha256=jLvt20gcUZYB8UOvyBvyKQ1qhYYhD__qP7ZDx2lPFkU,1062
-rgwfuncs-0.0.103.dist-info/METADATA,sha256=fR6-WFPr2FcT6vDJguK2U_wGh0qY0nMjnjZdt6tkJHU,42948
-rgwfuncs-0.0.103.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rgwfuncs-0.0.103.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
-rgwfuncs-0.0.103.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
-rgwfuncs-0.0.103.dist-info/RECORD,,