Rename 'setup_ssh_connection_to_central_server' to 'setup_ssh_connect…

…ion'.

datashuttle/datashuttle.py

@@ -76,7 +76,7 @@ class DataShuttle:
     cfgs.make_and_get_logging_path().
 
     For transferring data between a central data storage
-    with SSH, use setup setup_ssh_connection_to_central_server().
+    with SSH, use setup setup_ssh_connection().
     This will allow you to check the server key, add host key to
     profile if accepted, and setup ssh key pair.
 
@@ -588,7 +588,7 @@ def _transfer_specific_file_or_folder(
     # -------------------------------------------------------------------------
 
     @requires_ssh_configs
-    def setup_ssh_connection_to_central_server(self) -> None:
+    def setup_ssh_connection(self) -> None:
         """
         Setup a connection to the central server using SSH.
         Assumes the central_host_id and central_host_username

datashuttle/tui/screens/setup_ssh.py

@@ -20,7 +20,7 @@
 class SetupSshScreen(ModalScreen):
     """
     This dialog windows handles the TUI equivalent of API's
-    setup_connection_to_central_server(). This asks to
+    setup_ssh_connection(). This asks to
     confirm the central hostkey, and takes password to setup
     SSH key pair.
 

datashuttle/utils/ssh.py

@@ -176,7 +176,7 @@ def connect_client_with_logging(
     except Exception:
         utils.log_and_raise_error(
             f"Could not connect to server. Ensure that \n"
-            f"1) You have run setup_ssh_connection_to_central_server() \n"
+            f"1) You have run setup_ssh_connection() \n"
             f"2) You are on VPN network if required. \n"
             f"3) The central_host_id: {cfg['central_host_id']} is"
             f" correct.\n"

docs/source/pages/documentation.md

@@ -373,7 +373,7 @@ Next, a one-time command to setup the SSH connection must be run:
 
 :::{tab-item} Python API
 ```{code-block} python
-project.setup_ssh_connection_to_central_server()
+project.setup_ssh_connection()
 ```
 :::
 

docs/source/pages/how_tos/make-a-new-project.md

@@ -232,7 +232,7 @@ project.make_config_file(
 Next, a one-time command to set up the SSH connection must be run:
 
 ```{code-block} python
-project.setup_ssh_connection_to_central_server()
+project.setup_ssh_connection()
 ```
 
 Running `setup-ssh-connection-to-central-server` will require verification

docs/source/pages/how_tos/update-configs.md

@@ -51,7 +51,7 @@ If changing `SSH` configs, the connection may need to be
 [reconfigured](new-project-ssh) with:
 
 ```python
-project.setup_ssh_connection_to_central_server()
+project.setup_ssh_connection()
 ```
 
 :::

tests/tests_integration/test_ssh_setup.py

@@ -55,7 +55,7 @@ def test_verify_ssh_central_host_do_not_accept(
         """
         orig_builtin = ssh_test_utils.setup_mock_input(input_)
 
-        project.setup_ssh_connection_to_central_server()
+        project.setup_ssh_connection()
 
         ssh_test_utils.restore_mock_input(orig_builtin)