rgwfuncs 0.0.18__py3-none-any.whl → 0.0.19__py3-none-any.whl

rgwfuncs/__init__.py

@@ -1,5 +1,5 @@
 # This file is automatically generated
 # Dynamically importing functions from modules
 
-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, docs, 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, 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 .str_lib import send_telegram_message
+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, df_docs, 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, 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 .str_lib import send_telegram_message, str_docs

rgwfuncs/df_lib.py

@@ -29,7 +29,7 @@ import warnings
 warnings.filterwarnings("ignore", category=FutureWarning)
 
 
-def docs(method_type_filter: Optional[str] = None) -> None:
+def df_docs(method_type_filter: Optional[str] = None) -> None:
     """
     Print a list of function names in alphabetical order. If method_type_filter
     is specified, print the docstrings of the functions that match the filter.

rgwfuncs/str_lib.py

@@ -1,7 +1,50 @@
 import os
 import json
 import requests
-from typing import Tuple
+import inspect
+from typing import Tuple, Optional, Dict, Callable
+import warnings
+
+# Suppress all FutureWarnings
+warnings.filterwarnings("ignore", category=FutureWarning)
+
+
+def str_docs(method_type_filter: Optional[str] = None) -> None:
+    """
+    Print a list of function names in alphabetical order. If method_type_filter
+    is specified, print the docstrings of the functions that match the filter.
+    Using '*' as a filter will print the docstrings for all functions.
+
+    Parameters:
+        method_type_filter: Optional filter string representing a function name,
+        or '*' to display docstrings for all functions.
+    """
+    # Get the current module's namespace
+    current_module = __name__
+
+    local_functions: Dict[str, Callable] = {
+        name: obj for name, obj in globals().items()
+        if inspect.isfunction(obj) and obj.__module__ == current_module
+    }
+
+    # List of function names sorted alphabetically
+    function_names = sorted(local_functions.keys())
+
+    # Print function names
+    print("Functions in alphabetical order:")
+    for name in function_names:
+        print(name)
+
+    # If a filter is provided or '*', print the docstrings of functions
+    if method_type_filter:
+        # print("\nFiltered function documentation:")
+        for name, func in local_functions.items():
+            docstring: Optional[str] = func.__doc__
+            if docstring:
+                if method_type_filter == '*' or method_type_filter == name:
+                    # Print the entire docstring for the matching function
+                    print(f"\n{name}:\n{docstring}")
+
 
 def send_telegram_message(preset_name: str, message: str) -> None:
     """Send a Telegram message using the specified preset.
@@ -48,10 +91,10 @@ def send_telegram_message(preset_name: str, message: str) -> None:
 
     # Load the configuration
     config = load_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}
@@ -59,4 +102,3 @@ def send_telegram_message(preset_name: str, message: str) -> None:
     # Send the message
     response = requests.post(url, json=payload)
     response.raise_for_status()
-

{rgwfuncs-0.0.18.dist-info → rgwfuncs-0.0.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.18
+Version: 0.0.19
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -135,11 +135,48 @@ To display all docstrings, use:
 
 --------------------------------------------------------------------------------
 
-## Function References and Syntax Examples
+## String Based Functions
+
+### 1. str_docs
+Print a list of available function names in alphabetical order. If a filter is provided, print the matching docstrings.
+
+• Parameters:
+  - `method_type_filter` (str): Optional, comma-separated to select docstring types, or '*' for all.
+
+• Example:
+
+    import rgwfuncs
+    rgwfuncs.str_docs(method_type_filter='numeric_clean,limit_dataframe')
+
+--------------------------------------------------------------------------------
+
+### 2. send_telegram_message
+
+Send a message to a Telegram chat using a specified preset from your configuration file.
+
+• 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.
+
+• Raises:
+  - `RuntimeError`: If the preset is not found in the configuration file or if necessary details (bot token or chat ID) are missing.
+
+• Example:
+
+    from rgwfuncs import send_telegram_message
+    
+    preset_name = "daily_updates"
+    message = "Here is your daily update!"
+
+    send_telegram_message(preset_name, message)
+
+--------------------------------------------------------------------------------
+
+## Dataframe Based Functions
 
 Below is a quick reference of available functions, their purpose, and basic usage examples.
 
-### 1. docs
+### 1. df_docs
 Print a list of available function names in alphabetical order. If a filter is provided, print the matching docstrings.
 
 • Parameters:
@@ -148,7 +185,7 @@ Print a list of available function names in alphabetical order. If a filter is p
 • Example:
 
     import rgwfuncs
-    rgwfuncs.docs(method_type_filter='numeric_clean,limit_dataframe')
+    rgwfuncs.df_docs(method_type_filter='numeric_clean,limit_dataframe')
 
 --------------------------------------------------------------------------------
 

rgwfuncs-0.0.19.dist-info/RECORD

@@ -0,0 +1,9 @@
+rgwfuncs/__init__.py,sha256=2nrp3c5VmVrKh0Ih6zELL8niH9nAHN0XnObqe-EpxlE,1169
+rgwfuncs/df_lib.py,sha256=KVe7o9P3XZEDUlF-ilwA7bRZeJi212vSayCfxFCsXtw,67151
+rgwfuncs/str_lib.py,sha256=I5B0WOGaLUGaedMG7hqiKnIqV7Jc9h1RYlgOiC_-iGY,3678
+rgwfuncs-0.0.19.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
+rgwfuncs-0.0.19.dist-info/METADATA,sha256=q6-lkZGd4szwaagm98MKtFrM7XoC8CW9lZqwEbY_hEk,34681
+rgwfuncs-0.0.19.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+rgwfuncs-0.0.19.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
+rgwfuncs-0.0.19.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
+rgwfuncs-0.0.19.dist-info/RECORD,,

rgwfuncs-0.0.18.dist-info/RECORD

@@ -1,9 +0,0 @@
-rgwfuncs/__init__.py,sha256=XqJ8TJuc4HkQq3T5Gzjf3KTBsdJtyi2NKXBgbPuDn0Y,1156
-rgwfuncs/df_lib.py,sha256=rY1yVvY04uqR174JwYBFiRnujekr9mbe258wmu9OeeY,67148
-rgwfuncs/str_lib.py,sha256=6v9AXZ5wWsWVEcvcIz0B1rTmsvYaD-v53r2sYPcV4pU,2109
-rgwfuncs-0.0.18.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
-rgwfuncs-0.0.18.dist-info/METADATA,sha256=GfMK-J1vH4CG_fQqQAWwAvDE6JcSqNrKuNKvfOUKV_E,33442
-rgwfuncs-0.0.18.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-rgwfuncs-0.0.18.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
-rgwfuncs-0.0.18.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
-rgwfuncs-0.0.18.dist-info/RECORD,,