rgwfuncs 0.0.90__py3-none-any.whl → 0.0.91__py3-none-any.whl

rgwfuncs/df_lib.py

@@ -22,8 +22,7 @@ from email import encoders
 from googleapiclient.discovery import build
 import base64
 import boto3
-# import inspect
-from typing import Optional, Dict, List, Tuple, Any, Callable
+from typing import Optional, Dict, List, Tuple, Any, Callable, Union
 import warnings
 
 # Suppress all FutureWarnings
@@ -311,13 +310,17 @@ def drop_duplicates_retain_last(
     return df.drop_duplicates(subset=columns_list, keep='last')
 
 
-def load_data_from_query(db_preset_name: str, query: str) -> pd.DataFrame:
+def load_data_from_query(db_preset_name: str, query: str, config: Optional[Union[str, dict]] = None) -> pd.DataFrame:
     """
     Load data from a database query into a DataFrame based on a configuration preset.
 
     Parameters:
         db_preset_name: The name of the database preset in the configuration file.
         query: The SQL query to execute.
+        config (Optional[Union[str, dict]], optional): Configuration source. Can be:
+            - None: Uses default path '~/.rgwfuncsrc'
+            - str: Path to a JSON configuration file
+            - dict: Direct configuration dictionary
 
     Returns:
         A DataFrame containing the query result.
@@ -327,6 +330,27 @@ def load_data_from_query(db_preset_name: str, query: str) -> pd.DataFrame:
         ValueError: If the database preset or db_type is invalid.
     """
 
+    def get_config(config: Optional[Union[str, dict]] = None) -> dict:
+        """Get telegram configuration either from a path or direct dictionary."""
+        def get_config_from_file(config_path: str) -> dict:
+            """Load configuration from a JSON file."""
+            with open(config_path, 'r') as file:
+                return json.load(file)
+
+        # Determine the config to use
+        if config is None:
+            # Default to ~/.rgwfuncsrc if no config provided
+            config_path = os.path.expanduser('~/.rgwfuncsrc')
+            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 query_mssql(db_preset: Dict[str, Any], query: str) -> pd.DataFrame:
         server = db_preset['host']
         user = db_preset['username']
@@ -446,11 +470,7 @@ def load_data_from_query(db_preset_name: str, query: str) -> pd.DataFrame:
         wait_for_athena_query_to_complete(athena_client, query_execution_id)
         return download_athena_query_results(athena_client, query_execution_id)
 
-    # Assume the configuration file is located at ~/.rgwfuncsrc
-    config_path = os.path.expanduser('~/.rgwfuncsrc')
-    with open(config_path, 'r') as f:
-        config = json.load(f)
-
+    config = get_config(config)
     db_presets = config.get('db_presets', [])
     db_preset = next(
         (preset for preset in db_presets if preset['name'] == db_preset_name),
@@ -846,7 +866,8 @@ def send_dataframe_via_telegram(
         bot_name: str,
         message: Optional[str] = None,
         as_file: bool = True,
-        remove_after_send: bool = True) -> None:
+        remove_after_send: bool = True,
+        config: Optional[Union[str, dict]] = None) -> None:
     """
     Send a DataFrame via Telegram using a specified bot configuration.
 
@@ -856,6 +877,10 @@ def send_dataframe_via_telegram(
         message: Custom message to send along with the DataFrame or file. Defaults to None.
         as_file: Boolean flag to indicate whether the DataFrame should be sent as a file (True) or as text (False). Defaults to True.
         remove_after_send: If True, removes the CSV file after sending. Defaults to True.
+        config (Optional[Union[str, dict]], optional): Configuration source. Can be:
+            - None: Uses default path '~/.rgwfuncsrc'
+            - str: Path to a JSON configuration file
+            - dict: Direct configuration dictionary
 
     Raises:
         ValueError: If the specified bot is not found or if no DataFrame is provided.
@@ -865,14 +890,29 @@ def send_dataframe_via_telegram(
         The configuration file is assumed to be located at `~/.rgwfuncsrc`.
     """
 
-    def get_config(config_path: str) -> dict:
-        """Load configuration from a JSON file."""
-        with open(config_path, 'r') as file:
-            return json.load(file)
+    def get_config(config: Optional[Union[str, dict]] = None) -> dict:
+        """Get telegram configuration either from a path or direct dictionary."""
+        def get_config_from_file(config_path: str) -> dict:
+            """Load configuration from a JSON file."""
+            with open(config_path, 'r') as file:
+                return json.load(file)
+
+        # Determine the config to use
+        if config is None:
+            # Default to ~/.rgwfuncsrc if no config provided
+            config_path = os.path.expanduser('~/.rgwfuncsrc')
+            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")
 
-    # Assume the configuration file is located at ~/.rgwfuncsrc
-    config_path = os.path.expanduser('~/.rgwfuncsrc')
-    config = get_config(config_path)
+
+    config = get_config(config)
 
     bot_config = next(
         (bot for bot in config['telegram_bot_presets'] if bot['name'] == bot_name),
@@ -926,7 +966,8 @@ def send_data_to_email(
         subject: Optional[str] = None,
         body: Optional[str] = None,
         as_file: bool = True,
-        remove_after_send: bool = True) -> None:
+        remove_after_send: bool = True,
+        config: Optional[Union[str, dict]] = None) -> None:
     """
     Send an email with an optional DataFrame attachment using the Gmail API via a specified preset.
 
@@ -938,6 +979,10 @@ def send_data_to_email(
         body: Optional message body of the email. Defaults to 'Please find the CSV file attached.' if not given.
         as_file: Boolean flag to decide whether to send the DataFrame as a file (True) or embed it in the email (False). Defaults to True.
         remove_after_send: If True, removes the CSV file after sending. Defaults to True.
+        config (Optional[Union[str, dict]], optional): Configuration source. Can be:
+            - None: Uses default path '~/.rgwfuncsrc'
+            - str: Path to a JSON configuration file
+            - dict: Direct configuration dictionary
 
     Raises:
         ValueError: If the preset is not found in the configuration.
@@ -947,12 +992,26 @@ def send_data_to_email(
         The configuration file is assumed to be located at `~/.rgwfuncsrc`.
     """
 
-    def get_config(config_path: str) -> dict:
-        with open(config_path, 'r') as file:
-            try:
+    def get_config(config: Optional[Union[str, dict]] = None) -> dict:
+        """Get telegram configuration either from a path or direct dictionary."""
+        def get_config_from_file(config_path: str) -> dict:
+            """Load configuration from a JSON file."""
+            with open(config_path, 'r') as file:
                 return json.load(file)
-            except json.JSONDecodeError as e:
-                raise ValueError(f"Invalid JSON format in config file: {e}")
+
+        # Determine the config to use
+        if config is None:
+            # Default to ~/.rgwfuncsrc if no config provided
+            config_path = os.path.expanduser('~/.rgwfuncsrc')
+            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 authenticate_service_account(
             service_account_credentials_path: str,
@@ -964,9 +1023,7 @@ def send_data_to_email(
         )
         return build('gmail', 'v1', credentials=credentials)
 
-    # Load configuration from ~/.rgwfuncsrc
-    config_path = os.path.expanduser('~/.rgwfuncsrc')
-    config = get_config(config_path)
+    config = get_config(config)
 
     # Retrieve Gmail preset configuration
     gmail_config = next(
@@ -1038,7 +1095,8 @@ def send_data_to_slack(
         bot_name: str,
         message: Optional[str] = None,
         as_file: bool = True,
-        remove_after_send: bool = True) -> None:
+        remove_after_send: bool = True,
+        config: Optional[Union[str, dict]] = None) -> None:
     """
     Send a DataFrame or message to Slack using a specified bot configuration.
 
@@ -1048,6 +1106,10 @@ def send_data_to_slack(
         message: Custom message to send along with the DataFrame or file. Defaults to None.
         as_file: Boolean flag to decide whether to send the DataFrame as a file (True) or as text (False). Defaults to True.
         remove_after_send: If True, removes the CSV file after sending. Defaults to True.
+        config (Optional[Union[str, dict]], optional): Configuration source. Can be:
+            - None: Uses default path '~/.rgwfuncsrc'
+            - str: Path to a JSON configuration file
+            - dict: Direct configuration dictionary
 
     Raises:
         ValueError: If the specified bot is not found in the configuration.
@@ -1057,14 +1119,29 @@ def send_data_to_slack(
         The configuration file is assumed to be located at `~/.rgwfuncsrc`.
     """
 
-    def get_config(config_path: str) -> dict:
-        """Load configuration from a JSON file."""
-        with open(config_path, 'r') as file:
-            return json.load(file)
+    def get_config(config: Optional[Union[str, dict]] = None) -> dict:
+        """Get telegram configuration either from a path or direct dictionary."""
+        def get_config_from_file(config_path: str) -> dict:
+            """Load configuration from a JSON file."""
+            with open(config_path, 'r') as file:
+                return json.load(file)
+
+        # Determine the config to use
+        if config is None:
+            # Default to ~/.rgwfuncsrc if no config provided
+            config_path = os.path.expanduser('~/.rgwfuncsrc')
+            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")
 
     # Load the Slack configuration from ~/.rgwfuncsrc
-    config_path = os.path.expanduser('~/.rgwfuncsrc')
-    config = get_config(config_path)
+    config = get_config(config)
 
     bot_config = next(
         (bot for bot in config['slack_bot_presets'] if bot['name'] == bot_name),

rgwfuncs/interactive_shell_lib.py

@@ -11,20 +11,21 @@ from .algebra_lib import *  # noqa: F401, F403, E402
 from .str_lib import *  # noqa: F401, F403, E402
 from .docs_lib import *  # noqa: F401, F403, E402
 
+
 def interactive_shell(local_vars: Dict[str, Any]) -> None:
     """
     Launch an interactive prompt for inspecting and modifying local variables,
     with blue-colored output and a white prompt. An extra blank line appears before
     each new prompt, and the welcome banner appears in blue. No extra exit message is printed.
-    
+
     local_vars: dictionary of variables available in the interactive shell.
     """
-    
+
     # ANSI color escape codes.
     BLUE = "\033[94m"
     WHITE = "\033[37m"
     RESET = "\033[0m"
-    
+
     # Set up readline history.
     def setup_readline() -> None:
         HISTORY_FILE = os.path.expanduser("~/.rgwfuncs_shell_history")
@@ -36,13 +37,13 @@ def interactive_shell(local_vars: Dict[str, Any]) -> None:
             except Exception as e:
                 print(f"Warning: Could not load history file: {e}")
         atexit.register(readline.write_history_file, HISTORY_FILE)
-    
+
     # BlueStdout: a wrapper for sys.stdout to ensure output is in blue.
     class BlueStdout:
         def __init__(self, wrapped):
             self.wrapped = wrapped
             self.at_line_start = True
-            
+
         def write(self, s):
             # If the output exactly matches our prompt, leave it uncolored.
             if s == sys.ps1 or s == sys.ps2:
@@ -60,19 +61,19 @@ def interactive_shell(local_vars: Dict[str, Any]) -> None:
                     self.at_line_start = True
                 else:
                     self.at_line_start = (line == "")
-                    
+
         def flush(self):
             self.wrapped.flush()
-            
+
         def isatty(self):
             return self.wrapped.isatty()
-        
+
         def fileno(self):
             return self.wrapped.fileno()
-        
+
         def __getattr__(self, attr):
             return getattr(self.wrapped, attr)
-    
+
     # ColorInteractiveConsole: a subclass that temporarily restores the original stdout
     # while reading input and prints an extra blank line before each prompt.
     class ColorInteractiveConsole(code.InteractiveConsole):
@@ -86,37 +87,36 @@ def interactive_shell(local_vars: Dict[str, Any]) -> None:
             finally:
                 sys.stdout = saved_stdout
             return line
-    
+
     # Ensure local_vars is a dictionary.
     if not isinstance(local_vars, dict):
         raise TypeError("local_vars must be a dictionary")
-    
+
     # Initialize readline history.
     setup_readline()
-    
+
     # Merge globals into local_vars.
     local_vars.update(globals())
-    
+
     # Wrap ANSI escape codes with markers (\001 and \002) so readline ignores these in prompt length.
     sys.ps1 = "\001" + WHITE + "\002" + ">>> " + "\001" + RESET + "\002"
     sys.ps2 = "\001" + WHITE + "\002" + "... " + "\001" + RESET + "\002"
-    
+
     # Replace sys.stdout with BlueStdout to ensure all output is printed in blue.
     sys.stdout = BlueStdout(sys.__stdout__)
-    
+
     # Create our custom interactive console.
     console = ColorInteractiveConsole(locals=local_vars)
-    
+
     # The welcome banner is explicitly wrapped in BLUE and RESET.
     banner = (BLUE +
               "Welcome to the rgwfuncs interactive shell.\n"
               "Use up/down arrows for command history.\n"
               "Type 'exit()' or Ctrl+D to quit." +
               RESET)
-    
+
     # Call interact with an empty exit message.
     try:
         console.interact(banner=banner, exitmsg="")
     except SystemExit:
         pass
-

rgwfuncs/str_lib.py

@@ -1,32 +1,51 @@
 import os
 import json
 import requests
-from typing import Tuple
+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) -> None:
+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: Uses default path '~/.rgwfuncsrc'
+          - str: Path to a JSON configuration file
+          - dict: Direct configuration dictionary
 
     Raises:
         RuntimeError: If the preset is not found or necessary details are missing.
     """
 
-    # Set the config path to ~/.rgwfuncsrc
-    config_path = os.path.expanduser("~/.rgwfuncsrc")
+    def get_config(config: Optional[Union[str, dict]] = None) -> dict:
+        """Get telegram configuration either from a path or direct dictionary."""
+        def get_config_from_file(config_path: str) -> dict:
+            """Load configuration from a JSON file."""
+            with open(config_path, 'r') as file:
+                return json.load(file)
+
+        # Determine the config to use
+        if config is None:
+            # Default to ~/.rgwfuncsrc if no config provided
+            config_path = os.path.expanduser('~/.rgwfuncsrc')
+            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 load_config() -> dict:
-        """Load the configuration from the .rgwfuncsrc file."""
-        with open(config_path, 'r') as file:
-            return json.load(file)
 
     def get_telegram_preset(config: dict, preset_name: str) -> dict:
         """Get the Telegram preset configuration."""
@@ -53,9 +72,7 @@ def send_telegram_message(preset_name: str, message: str) -> None:
 
         return bot_token, chat_id
 
-    # Load the configuration
-    config = load_config()
-
+    config = get_config(config)
     # Get bot details from the configuration
     bot_token, chat_id = get_telegram_bot_details(config, preset_name)
 

{rgwfuncs-0.0.90.dist-info → rgwfuncs-0.0.91.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: rgwfuncs
-Version: 0.0.90
+Version: 0.0.91
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -24,6 +24,7 @@ Requires-Dist: requests
 Requires-Dist: slack-sdk
 Requires-Dist: google-api-python-client
 Requires-Dist: boto3
+Dynamic: license-file
 
 # RGWFUNCS
 
@@ -602,6 +603,10 @@ Send a message to a Telegram chat using a specified preset from your configurati
 • Parameters:
   - `preset_name` (str): The name of the preset to use for sending the message. This should match a preset in the configuration file.
   - `message` (str): The message text that you want to send to the Telegram chat.
+  - config (Optional[Union[str, dict]], optional): Configuration source. Can be:
+    - None: Uses default path '~/.rgwfuncsrc'
+    - str: Path to a JSON configuration file
+    - dict: Direct configuration dictionary
 
 • Raises:
   - `RuntimeError`: If the preset is not found in the configuration file or if necessary details (bot token or chat ID) are missing.
@@ -864,6 +869,10 @@ Load data from a specified database using a SQL query and return the results in
 
 - `db_preset_name` (str): The name of the database preset found in the configuration file. This preset determines which database connection details to use.
 - `query` (str): The SQL query string to be executed on the database.
+- `config` (Optional[Union[str, dict]], optional): Configuration source. Can be:
+  - None: Uses default path '~/.rgwfuncsrc'
+  - str: Path to a JSON configuration file
+  - dict: Direct configuration dictionary
 
 #### Returns
 
@@ -1127,6 +1136,10 @@ Send a DataFrame via Telegram using a specified bot configuration.
   - message (str)
   - `as_file` (bool)
   - `remove_after_send` (bool)
+  - `config` (Optional[Union[str, dict]], optional): Configuration source. Can be:
+    - None: Uses default path '~/.rgwfuncsrc'
+    - str: Path to a JSON configuration file
+    - dict: Direct configuration dictionary
 
 • Example:
     
@@ -1156,6 +1169,10 @@ Send an email with an optional DataFrame attachment using the Gmail API via a sp
   - body (str, optional)
   - `as_file` (bool)
   - `remove_after_send` (bool)
+  - `config` (Optional[Union[str, dict]], optional): Configuration source. Can be:
+    - None: Uses default path '~/.rgwfuncsrc'
+    - str: Path to a JSON configuration file
+    - dict: Direct configuration dictionary
 
 • Example:
     
@@ -1184,6 +1201,10 @@ Send a DataFrame or message to Slack using a specified bot configuration.
   - message (str)
   - `as_file` (bool)
   - `remove_after_send` (bool)
+  - `config` (Optional[Union[str, dict]], optional): Configuration source. Can be:
+    - None: Uses default path '~/.rgwfuncsrc'
+    - str: Path to a JSON configuration file
+    - dict: Direct configuration dictionary
 
 • Example:
     

rgwfuncs-0.0.91.dist-info/RECORD

@@ -0,0 +1,12 @@
+rgwfuncs/__init__.py,sha256=LSn54Tlyskcb6Wab_wUpPLB6UGMe5LdrB3GU88mDEbU,1712
+rgwfuncs/algebra_lib.py,sha256=rKFITfpWfgdBswnbMUuS41XgndEt-jUVz2ObO_ik7eM,42234
+rgwfuncs/df_lib.py,sha256=coAmZ2RyWvovorNekQnLW5cUIZyY-h6s88YUm0ytFAw,75107
+rgwfuncs/docs_lib.py,sha256=i63NzX-V8cGhikYdtkRGAEe2VcuwpXxDUyTRa9xI7l8,1972
+rgwfuncs/interactive_shell_lib.py,sha256=YN0ZnM5twIsOeDKuOQ9ZGURCvvBX0RZjM4a1vO1C3E8,4281
+rgwfuncs/str_lib.py,sha256=-dcJt-jE0YG-XwHcNslCM_Gp-L0Ho0zYFPxjrxepzzA,3210
+rgwfuncs-0.0.91.dist-info/licenses/LICENSE,sha256=jLvt20gcUZYB8UOvyBvyKQ1qhYYhD__qP7ZDx2lPFkU,1062
+rgwfuncs-0.0.91.dist-info/METADATA,sha256=BVQ4dPy_oI5jTtqwEBfj96OGqwIlOy8Ib57Je7Q6Tuk,61390
+rgwfuncs-0.0.91.dist-info/WHEEL,sha256=DK49LOLCYiurdXXOXwGJm6U4DkHkg4lcxjhqwRa0CP4,91
+rgwfuncs-0.0.91.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
+rgwfuncs-0.0.91.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
+rgwfuncs-0.0.91.dist-info/RECORD,,

{rgwfuncs-0.0.90.dist-info → rgwfuncs-0.0.91.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (78.0.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

rgwfuncs-0.0.90.dist-info/RECORD

@@ -1,12 +0,0 @@
-rgwfuncs/__init__.py,sha256=LSn54Tlyskcb6Wab_wUpPLB6UGMe5LdrB3GU88mDEbU,1712
-rgwfuncs/algebra_lib.py,sha256=rKFITfpWfgdBswnbMUuS41XgndEt-jUVz2ObO_ik7eM,42234
-rgwfuncs/df_lib.py,sha256=r6T-MwyDq9NAPW1Xf6NzSy7ZFicIKdemR-UKu6TZt5g,71111
-rgwfuncs/docs_lib.py,sha256=i63NzX-V8cGhikYdtkRGAEe2VcuwpXxDUyTRa9xI7l8,1972
-rgwfuncs/interactive_shell_lib.py,sha256=F9Kul06SK-X1DxFpINDLEHFab7UaqFHgx2eYmdmMoOg,4393
-rgwfuncs/str_lib.py,sha256=rtAdRlnSJIu3JhI-tA_A0wCiPK2m-zn5RoGpBxv_g-4,2228
-rgwfuncs-0.0.90.dist-info/LICENSE,sha256=jLvt20gcUZYB8UOvyBvyKQ1qhYYhD__qP7ZDx2lPFkU,1062
-rgwfuncs-0.0.90.dist-info/METADATA,sha256=VqTLa3ss_JZSpa0DWB8pOgCitIKCuSL7xIl02JjDShk,60288
-rgwfuncs-0.0.90.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-rgwfuncs-0.0.90.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
-rgwfuncs-0.0.90.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
-rgwfuncs-0.0.90.dist-info/RECORD,,