rgwfuncs 0.0.7__py3-none-any.whl → 0.0.8__py3-none-any.whl

rgwfuncs/df_lib.py

@@ -27,10 +27,13 @@ from typing import Optional, Callable, Dict, List, Tuple, Any
 
 def 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.
+    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, comma-separated to select docstring types, or '*' for all.
+        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__
@@ -41,7 +44,7 @@ def docs(method_type_filter: Optional[str] = None) -> None:
     }
 
     # List of function names sorted alphabetically
-    function_names: List[str] = sorted(local_functions.keys())
+    function_names = sorted(local_functions.keys())
 
     # Print function names
     print("Functions in alphabetical order:")
@@ -50,26 +53,13 @@ def docs(method_type_filter: Optional[str] = None) -> None:
 
     # If a filter is provided or '*', print the docstrings of functions
     if method_type_filter:
-        print("\nFiltered function documentation:")
+        # print("\nFiltered function documentation:")
         for name, func in local_functions.items():
             docstring: Optional[str] = func.__doc__
             if docstring:
-                if method_type_filter == '*':
-                    # Print the entire docstring for each function
+                if method_type_filter == '*' or method_type_filter == name:
+                    # Print the entire docstring for the matching function
                     print(f"\n{name}:\n{docstring}")
-                else:
-                    # Extract only the first line of the docstring
-                    first_line: str = docstring.split('\n')[0]
-                    if "::" in first_line:
-                        # Find the first occurrence of "::" and split there
-                        split_index: int = first_line.find("::")
-                        function_type: str = first_line[:split_index].strip()
-                        function_type_list: List[str] = [
-                            mt.strip() for mt in method_type_filter.split(',')]
-                        if function_type in function_type_list:
-                            # Print the entire docstring if the filter matches
-                            print(f"\n{name}:\n{docstring}")
-
 
 def numeric_clean(df: pd.DataFrame, column_names: str, column_type: str, irregular_value_treatment: str) -> pd.DataFrame:
     """

{rgwfuncs-0.0.7.dist-info → rgwfuncs-0.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.7
+Version: 0.0.8
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -77,7 +77,7 @@ A `rgwml.config` file (located at `vi ~/Documents/rgwml.config) is required for
           "project_id": ""
         }
       ],
-    "vm_presets": [
+      "vm_presets": [
         {
           "name": "main_server",
           "host": "",
@@ -85,34 +85,34 @@ A `rgwml.config` file (located at `vi ~/Documents/rgwml.config) is required for
           "ssh_key_path": ""
         }
       ],
-    "cloud_storage_presets": [
+      "cloud_storage_presets": [
         {
           "name": "gcs_bucket_name",
-          "credential_path": "path/to/your/credentials.json"
+          "credential_path": "/path/to/your/credentials.json"
         }
       ],
-    "telegram_bot_presets": [
-      {
-        "name": "rgwml-bot",
-        "chat_id": "",
-        "bot_token": ""
-      }
-    ],
-    "slack_bot_presets": [
-      {
-        "name": "labs-channel",
-        "channel_id": "",
-        "bot_token": ""
-      }
-    ],
-    "gmail_bot_presets": [
-      {
-        "name": "info@xyz.com",
-        "service_account_credentials_path": "/home/user/Documents/credentials/your_creds.json"
-      }
-    ]
-  }
-
+      "telegram_bot_presets": [
+        {
+          "name": "rgwml-bot",
+          "chat_id": "",
+          "bot_token": ""
+        }
+      ],
+      "slack_bot_presets": [
+        {
+          "name": "labs-channel",
+          "channel_id": "",
+          "bot_token": ""
+        }
+      ],
+      "gmail_bot_presets": [
+        {
+          "name": "info@xyz.com",
+          "service_account_credentials_path": "/path/to/your/credentials.json"
+        }
+      ]
+    }
+    
 --------------------------------------------------------------------------------
 
 ## Basic Usage

rgwfuncs-0.0.8.dist-info/RECORD

@@ -0,0 +1,8 @@
+rgwfuncs/__init__.py,sha256=o4BBYVERWwAx8dknJ03yVCHqV9o8D1qrRgFeJrtpDWg,1041
+rgwfuncs/df_lib.py,sha256=b_Xz4BnLAx2BFLj5bjzbVt5TcxOWN4oyHuCBnTZIKgs,60443
+rgwfuncs-0.0.8.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
+rgwfuncs-0.0.8.dist-info/METADATA,sha256=Ls5PvyV-OPQtxRzRdphYseP9dWIC8l0JE_NeVgYnSWQ,31259
+rgwfuncs-0.0.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+rgwfuncs-0.0.8.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
+rgwfuncs-0.0.8.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
+rgwfuncs-0.0.8.dist-info/RECORD,,

rgwfuncs-0.0.7.dist-info/RECORD

@@ -1,8 +0,0 @@
-rgwfuncs/__init__.py,sha256=o4BBYVERWwAx8dknJ03yVCHqV9o8D1qrRgFeJrtpDWg,1041
-rgwfuncs/df_lib.py,sha256=vYKElOUyMqBMC5EYA6vaqknpmVoOzNIyOWdJxMlzGcs,61137
-rgwfuncs-0.0.7.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
-rgwfuncs-0.0.7.dist-info/METADATA,sha256=CoUF-aVOBZmywYKpz2fLgd18Y0YRQieXGYp1E6ggMw8,31226
-rgwfuncs-0.0.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-rgwfuncs-0.0.7.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
-rgwfuncs-0.0.7.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
-rgwfuncs-0.0.7.dist-info/RECORD,,