osbot-utils 1.21.0__py3-none-any.whl → 1.23.0__py3-none-any.whl

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/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/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/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/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/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/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/version

@@ -1 +1 @@
-v1.21.0
+v1.23.0

{osbot_utils-1.21.0.dist-info → osbot_utils-1.23.0.dist-info}/METADATA

@@ -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.dist-info → osbot_utils-1.23.0.dist-info}/RECORD

@@ -57,7 +57,7 @@ osbot_utils/graphs/mgraph/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 osbot_utils/helpers/CFormat.py,sha256=1_XvqGwgU6qC97MbzcKF0o7s9mCXpU5Kq9Yf-1ixUwY,6808
 osbot_utils/helpers/CPrint.py,sha256=ztKPNmT8BGxeyPXSQKRs63PqqbgxKDz_BiZmzFMup9g,1413
 osbot_utils/helpers/Dict_To_Attr.py,sha256=NdhXl5mJH7-NaBk213amzc5Nfy3tJgW-N_uYIRE4hoc,208
-osbot_utils/helpers/Local_Cache.py,sha256=nxyorvXbXyWdlKkLeSeWmUhw1gE4SpOdso919IKfIE4,3046
+osbot_utils/helpers/Local_Cache.py,sha256=0JZZX3fFImcwtbBvxAQl-EbBegSNJRhRMYF6ovTH6zY,3141
 osbot_utils/helpers/Local_Caches.py,sha256=HvuP5CURyVm_fVvJX-S4dml2bhRauzgA3be237yTaeY,1814
 osbot_utils/helpers/Print_Table.py,sha256=LEXbyqGg_6WSraI4cob4bNNSu18ddqvALp1zGK7bPhs,19126
 osbot_utils/helpers/Python_Audit.py,sha256=shpZlluJwqJBAlad6xN01FkgC1TsQ48RLvR5ZjmrKa4,1539
@@ -217,11 +217,12 @@ osbot_utils/helpers/sqlite/tables/Sqlite__Table__Files.py,sha256=ZlhTqroHd9T8vqN
 osbot_utils/helpers/sqlite/tables/Sqlite__Table__Nodes.py,sha256=GT8h3wD4hGvEtqQuBs0sBbcu2ydktRHTi95PEL2ffHQ,1721
 osbot_utils/helpers/sqlite/tables/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/ssh/SCP.py,sha256=9PgJbyWKfxJj00Ijaj7o6ffxPXuNoureb6JlHMPbHww,3330
-osbot_utils/helpers/ssh/SSH.py,sha256=El2Op9b_pcr7msolwbbtkW74R2f_BJN_jdf3SQk_gk8,1081
+osbot_utils/helpers/ssh/SSH.py,sha256=jyRZIL8rif1Fn76i0ZJWSkY0VyQuB1J2LAWIvu4jKpU,1545
 osbot_utils/helpers/ssh/SSH__Cache__Requests.py,sha256=Dqh4biVcuaXbQVvn3Tx-kSGBGHiF-2wVsgu96EhD6gU,3359
-osbot_utils/helpers/ssh/SSH__Execute.py,sha256=2RjLEf8UuxsYjRoJDmbNdmx5LGgEN4pDS-DhXe3_mDs,6252
+osbot_utils/helpers/ssh/SSH__Execute.py,sha256=D5tQGbSPaNsrMvhTVT0sZIHpqF1rIYXYiaWzGExcwm4,6849
 osbot_utils/helpers/ssh/SSH__Health_Check.py,sha256=WDmBD6ejNcBeicXfjpsiNzH-WR3Jejx0re3WfwjSWyQ,2083
 osbot_utils/helpers/ssh/SSH__Linux.py,sha256=O1uyKcklaj2tHqQZln7dVinzjl9-EI52KzP8ojQr244,4330
+osbot_utils/helpers/ssh/SSH__Linux__Amazon.py,sha256=ZJFb7LFTvclAuhH5OoOtJ361NoX9ecHTaFX-iSmnzmk,596
 osbot_utils/helpers/ssh/SSH__Python.py,sha256=O2DAwkbXzwkis8lffoqIL2NPSfYcN44Mr8i9Ey2iMKk,2066
 osbot_utils/helpers/ssh/TestCase__SSH.py,sha256=rlhkiVr1OR_3uiwqK2dVZ-yBwZZpUhMq6BPT2p21H1s,1598
 osbot_utils/helpers/ssh/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -261,16 +262,16 @@ osbot_utils/utils/Assert.py,sha256=u9XLgYn91QvNWZGyPi29SjPJSXRHlm9andIn3NJEVog,1
 osbot_utils/utils/Call_Stack.py,sha256=MAq_0vMxnbeLfCe9qQz7GwJYaOuXpt3qtQwN6wiXsU0,6595
 osbot_utils/utils/Csv.py,sha256=oHLVpjRJqrLMz9lubMCNEoThXWju5rNTprcwHc1zq2c,1012
 osbot_utils/utils/Dev.py,sha256=HibpQutYy_iG8gGV8g1GztxNN4l29E4Bi7UZaVL6-L8,1203
-osbot_utils/utils/Env.py,sha256=_7SV5Jor7-GoMggYcwZflTO5D3eQKPvh73FXzC_fyGc,4858
+osbot_utils/utils/Env.py,sha256=pVKv_vJn0CU0DW6rj5hv5cfI2vupQZFptloSiaGjd8Y,4903
 osbot_utils/utils/Exceptions.py,sha256=KyOUHkXQ_6jDTq04Xm261dbEZuRidtsM4dgzNwSG8-8,389
-osbot_utils/utils/Files.py,sha256=HRMdDq1ZctDfCkIfuZGgQ3fG6O03qJEFEIkb8HTYzfU,19407
+osbot_utils/utils/Files.py,sha256=q4_JeNWZygM8T0_frpTGvZjtISC1ZyJTOr3bD9pCKUE,19599
 osbot_utils/utils/Functions.py,sha256=0E6alPJ0fJpBiJgFOWooCOi265wSRyxxXAJ5CELBnso,3498
 osbot_utils/utils/Http.py,sha256=Z8V149M2HDrKBoXkDD5EXgqTGx6vQoUqXugXK__wcuw,4572
 osbot_utils/utils/Int.py,sha256=PmlUdU4lSwf4gJdmTVdqclulkEp7KPCVUDO6AcISMF4,116
 osbot_utils/utils/Json.py,sha256=UNaBazuH1R40fsHjpjuK8kmAANmUHoK9Q0PUeYmgPeY,6254
 osbot_utils/utils/Json_Cache.py,sha256=mLPkkDZN-3ZVJiDvV1KBJXILtKkTZ4OepzOsDoBPhWg,2006
 osbot_utils/utils/Lists.py,sha256=CLEjgZwAixJAFlubWEKjnUUhUN85oqvR7UqExVW7rdY,5502
-osbot_utils/utils/Misc.py,sha256=5pVxQLCOcGNL3PtasOtQCN8ostg2X-H7mucdZjgg_ns,16580
+osbot_utils/utils/Misc.py,sha256=ljscBemI5wOhfkl1BVpsqshacTOCKkOisV4er9xPCWM,16640
 osbot_utils/utils/Objects.py,sha256=SNtQ1nJnqihwTcmIf_Hg9P3V7fHjxcVHSzC7vKKI34Q,14419
 osbot_utils/utils/Png.py,sha256=V1juGp6wkpPigMJ8HcxrPDIP4bSwu51oNkLI8YqP76Y,1172
 osbot_utils/utils/Process.py,sha256=lr3CTiEkN3EiBx3ZmzYmTKlQoPdkgZBRjPulMxG-zdo,2357
@@ -281,8 +282,8 @@ osbot_utils/utils/Toml.py,sha256=-bg9srF7ef31UCNFa0aL3CDeDKp14XeUVwRMQzMb_dI,107
 osbot_utils/utils/Version.py,sha256=Ww6ChwTxqp1QAcxOnztkTicShlcx6fbNsWX5xausHrg,422
 osbot_utils/utils/Zip.py,sha256=YFahdBguVK71mLdYy4m7mqVAQ5al-60QnTmYK-txCfY,6784
 osbot_utils/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=o-_WEzInxIO2B4oYaxJD3HXoT3MWSTq6e3KoW9rZp-I,8
-osbot_utils-1.21.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-1.21.0.dist-info/METADATA,sha256=0aIOGo4sPuKtaD1s0iAq3KhhLvqy_rF2vGKgrCq5H9o,1266
-osbot_utils-1.21.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-osbot_utils-1.21.0.dist-info/RECORD,,
+osbot_utils/version,sha256=53VeZ9pdur3uOW0jZ0xgOrWe1NDomr_JWgbBLtChg_g,8
+osbot_utils-1.23.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-1.23.0.dist-info/METADATA,sha256=6nl1O4DPerXYoazuL2vLDMJx4FjQNzvFPxKuLuSvImE,1266
+osbot_utils-1.23.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+osbot_utils-1.23.0.dist-info/RECORD,,