Merge pull request #590 from neuroinformatics-unit/rename_setup_google_drive_connection

Rename setup_google_drive_connection -> setup_gdrive_connection.

Author: JoeZiminski

datashuttle/datashuttle_class.py

@@ -846,7 +846,7 @@ def write_public_key(self, filepath: str) -> None:
     # -------------------------------------------------------------------------
 
     @check_configs_set
-    def setup_google_drive_connection(self) -> None:
+    def setup_gdrive_connection(self) -> None:
         """Set up a connection to Google Drive using the provided credentials.
 
         Assumes `gdrive_root_folder_id` is set in configs.

datashuttle/tui/interface.py

@@ -38,7 +38,7 @@ def __init__(self) -> None:
         self.name_templates: Dict = {}
         self.tui_settings: Dict = {}
 
-        self.google_drive_rclone_setup_process: subprocess.Popen | None = None
+        self.gdrive_rclone_setup_process: subprocess.Popen | None = None
         self.gdrive_setup_process_killed: bool = False
 
     def select_existing_project(self, project_name: str) -> InterfaceOutput:
@@ -512,7 +512,7 @@ def setup_key_pair_and_rclone_config(
     # Setup Google Drive
     # ----------------------------------------------------------------------------------
 
-    def setup_google_drive_connection(
+    def setup_gdrive_connection(
         self,
         gdrive_client_secret: Optional[str] = None,
         config_token: Optional[str] = None,
@@ -521,7 +521,7 @@ def setup_google_drive_connection(
 
         This is done by running the rclone setup function which returns a
         subprocess.Popen object. The process object is stored in
-        `self.google_drive_rclone_setup_process` to allow for termination
+        `self.gdrive_rclone_setup_process` to allow for termination
         of the process if needed. The `self.gdrive_setup_process_killed`
         flag is set to false to signal normal operation. The process is then
         awaited to ensure it completes successfully. If the process is killed
@@ -532,7 +532,7 @@ def setup_google_drive_connection(
             process = self.project._setup_rclone_gdrive_config(
                 gdrive_client_secret, config_token
             )
-            self.google_drive_rclone_setup_process = process
+            self.gdrive_rclone_setup_process = process
             self.gdrive_setup_process_killed = False
 
             self.await_successful_gdrive_connection_setup_raise_on_fail(
@@ -558,11 +558,11 @@ def get_rclone_message_for_gdrive_without_browser(
         except BaseException as e:
             return False, str(e)
 
-    def terminate_google_drive_setup(self) -> None:
+    def terminate_gdrive_setup(self) -> None:
         """Terminate rclone setup for Google Drive by killing the rclone process."""
-        assert self.google_drive_rclone_setup_process is not None
+        assert self.gdrive_rclone_setup_process is not None
 
-        process = self.google_drive_rclone_setup_process
+        process = self.gdrive_rclone_setup_process
 
         # Check if the process is still running
         if process.poll() is None:

datashuttle/tui/screens/setup_gdrive.py

@@ -91,7 +91,7 @@ def on_button_pressed(self, event: Button.Pressed) -> None:
             # see setup_gdrive_connection_and_update_ui()
             if self.setup_worker and self.setup_worker.is_running:
                 self.setup_worker.cancel()  # fix
-                self.interface.terminate_google_drive_setup()
+                self.interface.terminate_gdrive_setup()
             self.dismiss()
 
         elif event.button.id == "setup_gdrive_ok_button":
@@ -244,7 +244,7 @@ async def setup_gdrive_connection_and_update_ui(
         thread for Google Drive setup, sets `self.setup_worker` to the worker and
         awaits the worker to finish. After completion, it displays a
         success / failure screen. The setup on the lower level is a bit complicated.
-        The worker thread runs the `setup_google_drive_connection` method of the
+        The worker thread runs the `setup_gdrive_connection` method of the
         `Interface` class which spawns an rclone process to set up the connection.
         The rclone process object is stored in the `Interface` class to handle closing
         the process as the thread does not kill the process itself upon cancellation and
@@ -283,7 +283,7 @@ def setup_gdrive_connection(
         by this function are responsible for opening google's auth page to authenticate
         with Google Drive.
         """
-        success, output = self.interface.setup_google_drive_connection(
+        success, output = self.interface.setup_gdrive_connection(
             gdrive_client_secret, config_token
         )
         return success, output

docs/source/pages/get_started/set-up-a-project.md

@@ -341,7 +341,7 @@ the Google API Console. If not provided, [RClone's](https://rclone.org/) shared
 If not provided, it is assumed the `gdrive_root_folder_id` points directly to the project folder.
 
 Once the configs are saved, we can set up the connection by clicking `Set Up Google Drive Connection`
-(through the TUI) or running the function [](setup_google_drive_connection()) in Python.
+(through the TUI) or running the function [](setup_gdrive_connection()) in Python.
 
 ```{important}
 If you change the `gdrive_root_folder_id`, you must re-run the connection set up.
@@ -428,10 +428,10 @@ project.make_config_file(
 Next, a one-time command to set up the connection must be run:
 
 ```{code-block} python
-project.setup_google_drive_connection()
+project.setup_gdrive_connection()
 ```
 
-Running [](setup_google_drive_connection()) will prompt to you to enter your
+Running [](setup_gdrive_connection()) will prompt to you to enter your
 Google Drive client secret.
 
 Finally, you will be required to authenticate to Google Drive via your browser.

tests/tests_transfers/gdrive/gdrive_test_utils.py

@@ -52,7 +52,7 @@ def mock_input(_: str) -> str:
         "GDRIVE_CLIENT_SECRET"
     ]
 
-    project.setup_google_drive_connection()
+    project.setup_gdrive_connection()
 
     builtins.input = original_input
     gdrive.get_client_secret = original_get_secret