add: docstrings to setup connection functions; remove: aws region class

Author: shrey

datashuttle/__init__.py

@@ -2,7 +2,6 @@
 
 from datashuttle.datashuttle_class import DataShuttle
 from datashuttle.datashuttle_functions import quick_validate_project
-from datashuttle.configs.aws_regions import AWS_REGION
 
 
 try:

datashuttle/configs/aws_regions.py

@@ -41,48 +41,3 @@ def get_aws_regions() -> Dict[str, str]:
 
 def get_aws_regions_list() -> List[str]:
     return list(get_aws_regions().values())
-
-
-AWS_REGIONS_DICT = get_aws_regions()  # runtime constant
-
-
-class AWS_REGION:
-    """
-    A class to represent AWS regions as constants.
-    It is used to provide intellisense for AWS regions in IDEs.
-    """
-
-    US_EAST_1 = AWS_REGIONS_DICT["US_EAST_1"]
-    US_EAST_2 = AWS_REGIONS_DICT["US_EAST_2"]
-    US_WEST_1 = AWS_REGIONS_DICT["US_WEST_1"]
-    US_WEST_2 = AWS_REGIONS_DICT["US_WEST_2"]
-    CA_CENTRAL_1 = AWS_REGIONS_DICT["CA_CENTRAL_1"]
-    EU_WEST_1 = AWS_REGIONS_DICT["EU_WEST_1"]
-    EU_WEST_2 = AWS_REGIONS_DICT["EU_WEST_2"]
-    EU_WEST_3 = AWS_REGIONS_DICT["EU_WEST_3"]
-    EU_NORTH_1 = AWS_REGIONS_DICT["EU_NORTH_1"]
-    EU_SOUTH_1 = AWS_REGIONS_DICT["EU_SOUTH_1"]
-    EU_CENTRAL_1 = AWS_REGIONS_DICT["EU_CENTRAL_1"]
-    AP_SOUTHEAST_1 = AWS_REGIONS_DICT["AP_SOUTHEAST_1"]
-    AP_SOUTHEAST_2 = AWS_REGIONS_DICT["AP_SOUTHEAST_2"]
-    AP_NORTHEAST_1 = AWS_REGIONS_DICT["AP_NORTHEAST_1"]
-    AP_NORTHEAST_2 = AWS_REGIONS_DICT["AP_NORTHEAST_2"]
-    AP_NORTHEAST_3 = AWS_REGIONS_DICT["AP_NORTHEAST_3"]
-    AP_SOUTH_1 = AWS_REGIONS_DICT["AP_SOUTH_1"]
-    AP_EAST_1 = AWS_REGIONS_DICT["AP_EAST_1"]
-    SA_EAST_1 = AWS_REGIONS_DICT["SA_EAST_1"]
-    IL_CENTRAL_1 = AWS_REGIONS_DICT["IL_CENTRAL_1"]
-    ME_SOUTH_1 = AWS_REGIONS_DICT["ME_SOUTH_1"]
-    AF_SOUTH_1 = AWS_REGIONS_DICT["AF_SOUTH_1"]
-    CN_NORTH_1 = AWS_REGIONS_DICT["CN_NORTH_1"]
-    CN_NORTHWEST_1 = AWS_REGIONS_DICT["CN_NORTHWEST_1"]
-    US_GOV_EAST_1 = AWS_REGIONS_DICT["US_GOV_EAST_1"]
-    US_GOV_WEST_1 = AWS_REGIONS_DICT["US_GOV_WEST_1"]
-
-    @classmethod
-    def get_all_regions(cls):
-        return [
-            value
-            for key, value in vars(cls).items()
-            if not key.startswith("__") and isinstance(value, str)
-        ]

datashuttle/configs/canonical_configs.py

@@ -49,7 +49,6 @@ def get_canonical_configs() -> dict:
         "gdrive_root_folder_id": Optional[str],
         "aws_access_key_id": Optional[str],
         "aws_region": Optional[Literal[*get_aws_regions_list()]],
-        # "aws_s3_endpoint_url": Optional[str],
     }
 
     return canonical_configs

datashuttle/datashuttle_class.py

@@ -901,6 +901,20 @@ def write_public_key(self, filepath: str) -> None:
 
     @check_configs_set
     def setup_google_drive_connection(self) -> None:
+        """
+        Setup a connection to Google Drive using the provided credentials.
+        Assumes `gdrive_root_folder_id` is set in configs.
+
+        First, the user will be prompted to enter their Google Drive client
+        secret if `gdrive_client_id` is set in the configs.
+
+        Next, the user will be asked if their machine has access to a browser.
+        If not, they will be prompted to input a config_token after running an
+        rclone command displayed to the user on a machine with access to a browser.
+
+        Next, with the provided credentials, the final setup will be done. This
+        opens up a browser if the user confirmed access to a browser.
+        """
         self._start_log(
             "setup-google-drive-connection-to-central-server",
             local_vars=locals(),
@@ -912,7 +926,6 @@ def setup_google_drive_connection(self) -> None:
             gdrive_client_secret = None
 
         browser_available = gdrive.ask_user_for_browser(log=True)
-        config_token = None
 
         if not browser_available:
             config_token = gdrive.prompt_and_get_config_token(
@@ -921,6 +934,8 @@ def setup_google_drive_connection(self) -> None:
                 self.cfg.get_rclone_config_name("gdrive"),
                 log=True,
             )
+        else:
+            config_token = None
 
         self._setup_rclone_gdrive_config(
             gdrive_client_secret, config_token, log=True
@@ -937,6 +952,14 @@ def setup_google_drive_connection(self) -> None:
     @requires_aws_configs
     @check_configs_set
     def setup_aws_connection(self) -> None:
+        """
+        Setup a connection to AWS S3 buckets using the provided credentials.
+        Assumes `aws_access_key_id` and `aws_region` are set in configs.
+
+        First, the user will be prompted to input their AWS secret access key.
+
+        Next, with the provided credentials, the final connection setup will be done.
+        """
         self._start_log(
             "setup-aws-connection-to-central-server",
             local_vars=locals(),