osbot-utils 1.21.0__tar.gz → 1.23.0__tar.gz

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.21.0
+Version: 1.23.0
 Summary: OWASP Security Bot - Utils
 Home-page: https://github.com/owasp-sbot/OSBot-Utils
 License: MIT
@@ -22,7 +22,7 @@ Description-Content-Type: text/markdown
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v1.21.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.23.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/README.md

@@ -2,7 +2,7 @@
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v1.21.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.23.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/osbot_utils/helpers/Local_Cache.py

@@ -1,7 +1,8 @@
 from osbot_utils.utils.Misc import list_set
 from osbot_utils.utils.Dev import pprint
 from osbot_utils.decorators.methods.cache_on_self import cache_on_self
-from osbot_utils.utils.Files    import current_temp_folder, path_combine, create_folder, safe_file_name, file_exists, file_delete
+from osbot_utils.utils.Files import current_temp_folder, path_combine, create_folder, safe_file_name, file_exists, \
+    file_delete, file_size
 from osbot_utils.utils.Json import json_save_file, json_load_file
 
 
@@ -32,6 +33,9 @@ class Local_Cache:
     def cache_exists(self):
         return file_exists(self.path_cache_file())
 
+    def cache_file_size(self):
+        return file_size(self.path_cache_file())
+
     def create(self):
         if not self.cache_exists():
             self.save()

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/osbot_utils/helpers/ssh/SSH.py

@@ -1,16 +1,20 @@
 from osbot_utils.base_classes.Kwargs_To_Self        import Kwargs_To_Self
+from osbot_utils.base_classes.Type_Safe import Type_Safe
 from osbot_utils.decorators.methods.cache_on_self   import cache_on_self
 from osbot_utils.helpers.ssh.SCP                    import SCP
 from osbot_utils.helpers.ssh.SSH__Execute           import SSH__Execute
 from osbot_utils.helpers.ssh.SSH__Linux             import SSH__Linux
+from osbot_utils.helpers.ssh.SSH__Linux__Amazon import SSH__Linux__Amazon
 from osbot_utils.helpers.ssh.SSH__Python            import SSH__Python
 
-class SSH(Kwargs_To_Self):
+class SSH(Type_Safe):       # todo: add ip_address to global vars here, and when that is done, add the wait_for_ssh method (that exists in EC2_Instance)
 
     def setup(self):
         self.ssh_execute().setup()
         return self
 
+    def exec(self,command):
+        return self.ssh_execute().execute_command(command)
     @cache_on_self
     def scp(self):
         kwargs = self.ssh_execute().__locals__()        # get the current ssh config details
@@ -25,6 +29,11 @@ class SSH(Kwargs_To_Self):
     def ssh_linux(self):
         return SSH__Linux(ssh_execute = self.ssh_execute())
 
+    @cache_on_self
+    def ssh_linux_amazon(self):
+        return SSH__Linux__Amazon(ssh_execute=self.ssh_execute())
+
     @cache_on_self
     def ssh_python(self):
-        return SSH__Python(ssh_execute = self.ssh_execute(), ssh_linux = self.ssh_linux())
+        return SSH__Python(ssh_execute = self.ssh_execute(), ssh_linux = self.ssh_linux())
+

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/osbot_utils/helpers/ssh/SSH__Execute.py

@@ -21,6 +21,7 @@ class SSH__Execute(Type_Safe):
     ssh_key_file      : str
     ssh_key_user      : str
     strict_host_check : bool = False
+    print_after_exec  : bool = False
 
     # execution & other commands # todo refactor into separate class
     def exec(self, command):
@@ -29,7 +30,7 @@ class SSH__Execute(Type_Safe):
     def exec__print(self, command):
         result = self.execute_command__return_stdout(command)
         self.print_header_for_command(command)
-        print(result)
+        self.print_status__stderr__stdout(result)
         return result
 
     def execute_command(self, command):
@@ -38,13 +39,15 @@ class SSH__Execute(Type_Safe):
             with capture_duration() as duration:
                 result          = start_process("ssh", ssh_args)                                 # execute command using subprocess.run(...)
             result['duration']  = duration.data()
+            if self.print_after_exec:
+                self.print_status__stderr__stdout(result)
             return result
         return status_error(error='in execute_command not all required vars were setup')
 
     def execute_command__print(self, command):
         self.print_header_for_command(command)
         result = self.execute_command(command)
-        pprint(result)
+        self.print_status__stderr__stdout(result)
         return result
 
     def execute_ssh_args(self):
@@ -142,8 +145,14 @@ class SSH__Execute(Type_Safe):
     #     pprint(self.ls(path))
     #     return self
 
-    def print_exec(self, command=''):
-        return self.exec__print(command)
+    def print_status__stderr__stdout(self, result):
+        print()
+        print( '┌──────────────────────────────────────────')
+        print(f'├ command: {result.get("command")        }')
+        print(f'│ status : {result.get("status" ).strip()}')
+        print(f'│ stderr : {result.get("stderr" ).strip()}')
+        print(f'│ stdout : {result.get("stdout" ).strip()}')
+        return self
 
     def print_header_for_command(self, command):
         print('\n')

osbot_utils-1.23.0/osbot_utils/helpers/ssh/SSH__Linux__Amazon.py

@@ -0,0 +1,14 @@
+from osbot_utils.helpers.ssh.SSH__Linux import SSH__Linux
+
+
+class SSH__Linux__Amazon(SSH__Linux):
+
+    def install_python3(self):
+        execute_commands = ('sudo yum install -y python3.11                 && '  
+                            'curl -O https://bootstrap.pypa.io/get-pip.py   && '
+                            'sudo python3.11 get-pip.py'                       )
+
+        return self.ssh_execute.execute_command__return_stdout(execute_commands)
+
+    def pip_install(self, package_name):
+        return self.ssh_execute.execute_command__return_stdout(f'pip3.11 install {package_name}')

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/osbot_utils/utils/Env.py

@@ -63,30 +63,32 @@ def env_unload_from_file(path):
                 if key in os.environ:  # Remove the environment variable if it exists
                     del os.environ[key]
 
+def find_dotenv_file(start_path=None, env_file_to_find='.env'):
+    directories = all_parent_folders(path=start_path, include_path=True)  # Define the possible directories to search for the .env file (which is this and all parent folders)
+    for directory in directories:                                         # Iterate through the directories and load the .env file if found
+        env_path = os.path.join(directory,env_file_to_find)               # Define the path to the .env file
+        if os.path.exists(env_path):                                      # If we found one
+            return env_path                                               # return the path to the .env file
+
 def in_github_action():
     return os.getenv('GITHUB_ACTIONS') == 'true'
 
 def in_python_debugger():
     if sys.gettrace() is not None:              # Check for a trace function
         return True
-
     pycharm_hosted           = os.getenv('PYCHARM_HOSTED') == '1'                     # Check for PyCharm specific environment variables and other potential indicators
     pydevd_load_values_async = os.getenv('PYDEVD_LOAD_VALUES_ASYNC') is not None
     if pycharm_hosted and pydevd_load_values_async:
         return True
-
     return False
 
 def load_dotenv(dotenv_path=None, override=False):
-    if dotenv_path:                                                 # If a specific dotenv path is provided, load from it
+    if dotenv_path:                                             # If a specific dotenv path is provided, load from it
         env_load_from_file(dotenv_path, override)
     else:
-        directories = all_parent_folders(include_path=True)         # Define the possible directories to search for the .env file (which is this and all parent folders)
-        for directory in directories:                               # Iterate through the directories and load the .env file if found
-            env_path = os.path.join(directory, '.env')              # Define the path to the .env file
-            if os.path.exists(env_path):                            # If we found one
-                env_load_from_file(env_path, override)              # Process it
-                break                                               # Stop after loading the first .env file                                                     # Stop after loading the first .env file
+        env_file = find_dotenv_file()
+        if env_file:
+            env_load_from_file(env_file, override)              # Process it
 
 
 def not_in_github_action():

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/osbot_utils/utils/Files.py

@@ -315,8 +315,10 @@ class Files:
             return abspath(join(parent_path,sub_path))
 
     @staticmethod
-    def parent_folder(path):
+    def parent_folder(path, use_full_path=False):
         if path:
+            if use_full_path:
+                path = file_full_path(path)
             return os.path.dirname(path)
 
     @staticmethod
@@ -429,6 +431,8 @@ class Files:
         return path
 
 # todo: refactor the methods above into static methods (as bellow)
+def absolute_path(path):
+    return abspath(path)
 
 def all_parent_folders(path=None, include_path=False):
     if path is None:
@@ -498,6 +502,7 @@ file_create_gz                 = Files.write_gz
 file_exists                    = Files.exists
 file_extension                 = Files.file_extension
 file_extension_fix             = Files.file_extension_fix
+file_full_path                 = absolute_path
 file_lines                     = Files.lines
 file_lines_gz                  = Files.lines_gz
 file_md5                       = Files.contents_md5

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/osbot_utils/utils/Misc.py

@@ -384,6 +384,9 @@ def random_text(prefix:str=None,length:int=12, lowercase=False):
 def random_uuid():
     return str(uuid.uuid4())
 
+def random_uuid_short():
+    return str(uuid.uuid4())[0:6]
+
 def remove(target_string, string_to_remove):                        # todo: refactor to str_*
     return replace(target_string, string_to_remove, '')
 

osbot_utils-1.23.0/osbot_utils/version

@@ -0,0 +1 @@
+v1.23.0

{osbot_utils-1.21.0 → osbot_utils-1.23.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name        = "osbot_utils"
-version     = "v1.21.0"
+version     = "v1.23.0"
 description = "OWASP Security Bot - Utils"
 authors     = ["Dinis Cruz <dinis.cruz@owasp.org>"]
 license     = "MIT"

osbot_utils-1.21.0/osbot_utils/version

@@ -1 +0,0 @@
-v1.21.0