fivetran-connector-sdk 0.8.12.1__py3-none-any.whl → 0.8.19.1__py3-none-any.whl

fivetran_connector_sdk/__init__.py

@@ -23,7 +23,7 @@ from fivetran_connector_sdk.protos import common_pb2
 from fivetran_connector_sdk.protos import connector_sdk_pb2
 from fivetran_connector_sdk.protos import connector_sdk_pb2_grpc
 
-__version__ = "0.8.12.1"
+__version__ = "0.8.19.1"
 
 MAC_OS = "mac"
 WIN_OS = "windows"
@@ -39,6 +39,7 @@ OUTPUT_FILES_DIR = "files"
 ONE_DAY_IN_SEC = 24 * 60 * 60
 
 EXCLUDED_DIRS = ["__pycache__", "lib", "include", OUTPUT_FILES_DIR]
+EXCLUDED_PIPREQS_DIRS = ["bin,etc,include,lib,Lib,lib64,Scripts"]
 
 DEBUGGING = False
 TABLES = {}
@@ -236,7 +237,7 @@ def check_newer_version():
     obtainer = GetPyPiLatestVersion()
     latest_version = obtainer('fivetran_connector_sdk')
     if __version__ < latest_version:
-        print(f"[notice] A new release of 'fivetran-connector-sdk' available: {latest_version}\n" +
+        print(f"[notice] A new release of 'fivetran-connector-sdk' is available: {latest_version}\n" +
               f"[notice] To update, run: pip install --upgrade fivetran-connector-sdk\n")
 
     with open(last_check_file_path, 'w') as f_out:
@@ -279,8 +280,6 @@ def _map_data_to_columns(data: dict, columns: dict) -> dict:
     for k, v in data.items():
         if v is None:
             mapped_data[k] = common_pb2.ValueType(null=True)
-        elif isinstance(v, list):
-            raise ValueError("Value type cannot be list")
         elif (k in columns) and columns[k].type != common_pb2.DataType.UNSPECIFIED:
             if columns[k].type == common_pb2.DataType.BOOLEAN:
                 mapped_data[k] = common_pb2.ValueType(bool=v)
@@ -325,7 +324,7 @@ def _map_data_to_columns(data: dict, columns: dict) -> dict:
             elif columns[k].type == common_pb2.DataType.JSON:
                 mapped_data[k] = common_pb2.ValueType(json=json.dumps(v))
             else:
-                raise ValueError(f"Unknown data type: {columns[k].type}")
+                raise ValueError(f"Unsupported data type encountered: {columns[k].type}. Please use valid data types.")
         else:
             # We can infer type from the value
             if isinstance(v, int):
@@ -340,7 +339,7 @@ def _map_data_to_columns(data: dict, columns: dict) -> dict:
             elif isinstance(v, bytes):
                 mapped_data[k] = common_pb2.ValueType(binary=v)
             elif isinstance(v, list):
-                raise ValueError("Value type cannot be list")
+                raise ValueError("Values for the columns cannot be of type 'list'. Please ensure that all values are of a supported type. Reference: https://fivetran.com/docs/connectors/connector-sdk/technical-reference#supporteddatatypes")
             elif isinstance(v, dict):
                 mapped_data[k] = common_pb2.ValueType(json=json.dumps(v))
             elif isinstance(v, str):
@@ -371,11 +370,11 @@ def _yield_check(stack):
     calling_code = stack[1].code_context[0]
     if f"{called_method}(" in calling_code:
         if 'yield' not in calling_code:
-            print(f"ERROR: Please add 'yield' to '{called_method}' operation on line {stack[1].lineno} in file '{stack[1].filename}'")
+            print(f"SEVERE: Please add 'yield' to '{called_method}' operation on line {stack[1].lineno} in file '{stack[1].filename}'")
             os._exit(1)
     else:
         # This should never happen
-        raise RuntimeError(f"Unable to find '{called_method}' function in stack")
+        raise RuntimeError(f"The '{called_method}' function is missing in the connector. Please ensure that the '{called_method}' function is properly defined in your code to proceed. Reference: https://fivetran.com/docs/connectors/connector-sdk/technical-reference#technicaldetailsmethods")
 
 
 def _check_dict(incoming: dict, string_only: bool = False) -> dict:
@@ -392,12 +391,12 @@ def _check_dict(incoming: dict, string_only: bool = False) -> dict:
         return {}
 
     if not isinstance(incoming, dict):
-        raise ValueError("Configuration should be a dictionary")
+        raise ValueError("Configuration must be provided as a JSON dictionary. Please check your input. Reference: https://fivetran.com/docs/connectors/connector-sdk/detailed-guide#workingwithconfigurationjsonfile")
 
     if string_only:
         for k, v in incoming.items():
             if not isinstance(v, str):
-                print("ERROR: Use only string values in configuration")
+                print("SEVERE: All values in the configuration must be STRING. Please check your configuration and ensure that every value is a STRING.")
                 os._exit(1)
 
     return incoming
@@ -417,28 +416,6 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
         self.configuration = None
         self.state = None
 
-    # Call this method to unpause and start a connector
-    def start(self, deploy_key: str, group: str, connection: str):
-        """Starts the connector with the given deployment key, group name, and connection schema name.
-
-        Args:
-            deploy_key (str): The deployment key.
-            group (str): The group name.
-            connection (str): The connection schema name.
-        """
-        if not deploy_key: print("ERROR: Missing deploy key"); os._exit(1)
-        if not connection: print("ERROR: Missing connection name"); os._exit(1)
-
-        group_id, group_name = self.__get_group_info(group, deploy_key)
-        connection_id = self.__get_connection_id(connection, group, group_id, deploy_key)
-        if not self.__unpause_connection():
-            print(f"WARNING: Unable to unpause connection '{connection}'")
-            os._exit(1)
-
-        if not self.__force_sync(connection_id, connection, deploy_key):
-            print(f"WARNING: Unable to start sync on connection '{connection}'")
-            os._exit(1)
-
     @staticmethod
     def __unpause_connection(id: str, deploy_key: str) -> bool:
         """Unpauses the connection with the given ID and deployment key.
@@ -495,7 +472,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
             is_deploy (bool): If `True`, the method will exit the process on critical errors.
 
         """
-        subprocess.run(["pipreqs", "--savepath", "tmp_requirements.txt"], text=True, check=True)
+        subprocess.run(["pipreqs", "--savepath", "tmp_requirements.txt", "--ignore"] + EXCLUDED_PIPREQS_DIRS, text=True, check=True)
         tmp_requirements_file_path = os.path.join(project_path, 'tmp_requirements.txt')
 
         tmp_requirements = self.fetch_requirements_as_dict(self, tmp_requirements_file_path)
@@ -553,8 +530,8 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
             connection (str): The connection name.
             configuration (dict): The configuration dictionary.
         """
-        if not deploy_key: print("ERROR: Missing deploy key"); os._exit(1)
-        if not connection: print("ERROR: Missing connection name"); os._exit(1)
+        if not deploy_key: print("SEVERE: The Fivetran API key is missing. Please provide a valid Fivetran API key to create the connector."); os._exit(1)
+        if not connection: print("SEVERE: The connection name is missing. Please provide a valid connection name to create the connector."); os._exit(1)
         _check_dict(configuration)
 
         secrets_list = []
@@ -572,7 +549,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
         self.validate_requirements_file(project_path, True)
 
         group_id, group_name = self.__get_group_info(group, deploy_key)
-        print(f"Deploying '{project_path}' to '{group_name}/{connection}'")
+        print(f"INFO: Deploying '{project_path}' to connector '{connection}' in destination '{group_name}'.\n")
         upload_file_path = self.__create_upload_file(project_path)
         upload_result = self.__upload(upload_file_path, deploy_key, group_id, connection)
         os.remove(upload_file_path)
@@ -580,15 +557,15 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
             os._exit(1)
         connection_id = self.__get_connection_id(connection, group, group_id, deploy_key)
         if connection_id:
-            print(f"Connection '{connection}' already exists in destination '{group}', updating .. ", end="", flush=True)
+            print(f"INFO: The connection '{connection}' already exists in destination '{group}', updating the existing connector... ", end="", flush=True)
             self.__update_connection(connection_id, connection, group_name, connection_config, deploy_key)
             print("✓")
         else:
             response = self.__create_connection(deploy_key, group_id, connection_config)
             if response.ok:
-                print(f"New connection with name '{connection}' created")
+                print(f"INFO: Connection named '{connection}' has been created successfully.\n")
             else:
-                print(f"ERROR: Failed to create new connection: {response.json()['message']}")
+                print(f"SEVERE: Unable to create a new Connection, failed with error: {response.json()['message']}")
                 os._exit(1)
 
     @staticmethod
@@ -629,7 +606,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
                         })
 
         if not resp.ok:
-            print(f"ERROR: Unable to update connection '{name}' in group '{group}'")
+            print(f"SEVERE: Unable to update Connection '{name}' in destination '{group}', failed with error: '{response.json()['message']}'.")
             os._exit(1)
 
     @staticmethod
@@ -649,7 +626,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
                       headers={"Authorization": f"Basic {deploy_key}"},
                       params={"schema": name})
         if not resp.ok:
-            print(f"ERROR: Unable to fetch connection list in group '{group}'")
+            print(f"SEVERE: Unable to fetch connection list in destination '{group}'")
             os._exit(1)
 
         if resp.json()['data']['items']:
@@ -690,7 +667,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
         Returns:
             str: The path to the upload file.
         """
-        print("Packaging project for upload ..")
+        print("INFO: Packaging your project for upload...")
         zip_file_path = self.__zip_folder(project_path)
         print("✓")
         return zip_file_path
@@ -717,7 +694,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
                     zipf.write(file_path, arcname)
 
         if not connector_file_exists:
-            print("ERROR: Missing connector.py file")
+            print("SEVERE: The 'connector.py' file is missing. Please ensure that 'connector.py' is present in your project directory, and that the file name is in lowercase letters. All custom connectors require this file because Fivetran calls it to start a sync.")
             os._exit(1)
         return upload_filepath
 
@@ -759,7 +736,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
         Returns:
             bool: True if the upload was successful, False otherwise.
         """
-        print("Uploading project .. ", end="", flush=True)
+        print("INFO: Uploading your project...", end="", flush=True)
         response = rq.post(f"https://api.fivetran.com/v2/deploy/{group_id}/{connection}",
                            files={'file': open(local_path, 'rb')},
                            headers={"Authorization": f"Basic {deploy_key}"})
@@ -767,7 +744,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
             print("✓")
             return True
 
-        print("fail\nERROR: ", response.reason)
+        print("SEVERE: Unable to upload the project, failed with error: ", response.reason)
         return False
 
     @staticmethod
@@ -801,27 +778,27 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
                       headers={"Authorization": f"Basic {deploy_key}"})
 
         if not resp.ok:
-            print(f"ERROR: Unable to fetch list of destination names, status code = {resp.status_code}")
+            print(f"SEVERE: Unable to fetch list of destination names, status code = {resp.status_code}")
             os._exit(1)
 
         # TODO: Do we need to implement pagination?
         groups = resp.json()['data']['items']
         if not groups:
-            print("ERROR: No destinations defined in the account")
+            print("SEVERE: No destinations defined in the account")
             os._exit(1)
 
         if len(groups) == 1:
             return groups[0]['id'], groups[0]['name']
         else:
             if not group:
-                print("ERROR: Destination name is required when there are multiple destinations in the account")
+                print("SEVERE: Destination name is required when there are multiple destinations in the account")
                 os._exit(1)
 
             for grp in groups:
                 if grp['name'] == group:
                     return grp['id'], grp['name']
 
-        print(f"ERROR: Specified destination was not found in the account: {group}")
+        print(f"SEVERE: Specified destination was not found in the account: {group}")
         os._exit(1)
 
     # Call this method to run the connector in production
@@ -899,17 +876,17 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
             download_filename = f"sdk-connector-tester-{os_name}-{TESTER_VERSION}.zip"
             download_filepath = os.path.join(tester_root_dir, download_filename)
             try:
-                print(f"Downloading connector tester version {TESTER_VERSION} .. ", end="", flush=True)
+                print(f"INFO: Downloading connector tester version: {TESTER_VERSION} ", end="", flush=True)
                 download_url = f"https://github.com/fivetran/fivetran_sdk_tools/releases/download/{TESTER_VERSION}/{download_filename}"
                 r = rq.get(download_url)
                 if r.ok:
                     with open(download_filepath, 'wb') as fo:
                         fo.write(r.content)
                 else:
-                    print(f"\nDownload failed, status code: {r.status_code}, url: {download_url}")
+                    print(f"\nSEVERE: Failed to download the connector tester. Please check your access permissions or try again later ( status code: {r.status_code}), url: {download_url}")
                     os._exit(1)
             except:
-                print(f"\nSomething went wrong during download: {traceback.format_exc()}")
+                print(f"\nSEVERE: Failed to download the connector tester. Error details: {traceback.format_exc()}")
                 os._exit(1)
 
             try:
@@ -924,13 +901,13 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
                 os.chmod(java_exe, st.st_mode | stat.S_IEXEC)
                 print("✓")
             except:
-                print(f"\nSomething went wrong during install: ", traceback.format_exc())
+                print(f"\nSEVERE: Failed to install the connector tester. Error details: ", traceback.format_exc())
                 shutil.rmtree(tester_root_dir)
                 os._exit(1)
 
         project_path = os.getcwd() if project_path is None else project_path
         self.validate_requirements_file(project_path, False)
-        print(f"Debugging connector at: {project_path}")
+        print(f"INFO: Debugging connector at: {project_path}")
         server = self.run(port, configuration, state, log_level=log_level)
 
         # Uncomment this to run the tester manually
@@ -938,7 +915,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
 
         error = False
         try:
-            print(f"Starting connector tester..")
+            print(f"INFO: Running connector tester...")
             for log_msg in self.__run_tester(java_exe, tester_root_dir, project_path, port):
                 print(log_msg, end="")
         except:
@@ -1121,7 +1098,7 @@ class Connector(connector_sdk_pb2_grpc.ConnectorServicer):
                             elif type.upper() == "JSON":
                                 column.type = common_pb2.DataType.JSON
                             else:
-                                raise ValueError("Unrecognized column type: ", str(type))
+                                raise ValueError("Unrecognized column type encountered:: ", str(type))
 
                         elif isinstance(type, dict):
                             if type['type'].upper() != "DECIMAL":
@@ -1190,7 +1167,7 @@ def find_connector_object(project_path) -> Connector:
             if '<fivetran_connector_sdk.Connector object at' in str(obj_attr):
                 return obj_attr
 
-    print("Unable to find connector object")
+    print("SEVERE: The connector object is missing. Please ensure that you have defined a connector object using the correct syntax in your `connector.py` file. Reference: https://fivetran.com/docs/connectors/connector-sdk/technical-reference#technicaldetailsrequiredobjectconnector")
     sys.exit(1)
 
 
@@ -1202,7 +1179,7 @@ def main():
     parser = argparse.ArgumentParser(allow_abbrev=False)
 
     # Positional
-    parser.add_argument("command", help="debug|run|deploy|start")
+    parser.add_argument("command", help="debug|deploy")
     parser.add_argument("project_path", nargs='?', default=os.getcwd(), help="Path to connector project directory")
 
     # Optional (Not all of these are valid with every mutually exclusive option below)
@@ -1230,7 +1207,7 @@ def main():
             with open(json_filepath, 'r') as fi:
                 configuration = json.load(fi)
         else:
-            raise ValueError("Configuration needs to be a JSON file")
+            raise ValueError("Configuration must be provided as a JSON file. Please check your input. Reference: https://fivetran.com/docs/connectors/connector-sdk/detailed-guide#workingwithconfigurationjsonfile")
     else:
         configuration = {}
 
@@ -1251,25 +1228,10 @@ def main():
             print("WARNING: 'state' parameter is not used for 'deploy' command")
         connector_object.deploy(args.project_path, ft_deploy_key, ft_group, ft_connection, configuration)
 
-    elif args.command.lower() == "start":
-        if args.port:
-            print("WARNING: 'port' parameter is not used for 'deploy' command")
-        if args.state:
-            print("WARNING: 'state' parameter is not used for 'deploy' command")
-        connector_object.start(ft_deploy_key, ft_group, ft_connection)
-
     elif args.command.lower() == "debug":
         port = 50051 if not args.port else args.port
         connector_object.debug(args.project_path, port, configuration, state)
 
-    elif args.command.lower() == "run":
-        try:
-            port = 50051 if not args.port else args.port
-            connector_object.run(port, configuration, state)
-        except:
-            Logging.severe(traceback.format_exc())
-            os._exit(1)
-
     else:
         raise NotImplementedError("Invalid command: ", args.command)
 

{fivetran_connector_sdk-0.8.12.1.dist-info → fivetran_connector_sdk-0.8.19.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fivetran_connector_sdk
-Version: 0.8.12.1
+Version: 0.8.19.1
 Summary: Build custom connectors on Fivetran platform
 Author-email: Fivetran <developers@fivetran.com>
 Project-URL: Homepage, https://fivetran.com/docs/connectors/connector-sdk

{fivetran_connector_sdk-0.8.12.1.dist-info → fivetran_connector_sdk-0.8.19.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-fivetran_connector_sdk/__init__.py,sha256=OaXaLM_1xxs7sF6sBAB3aBW4b9DTpc_mR6q23pGgQnw,49697
+fivetran_connector_sdk/__init__.py,sha256=DRdHyxqKeBGsvwYcqe2aCmM3AlVCiqVjbLQvRkfFVs0,49915
 fivetran_connector_sdk/protos/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fivetran_connector_sdk/protos/common_pb2.py,sha256=kUwVcyZHgLigNR-KnHZn7dHrlxaMnUXqzprsRx6T72M,6831
 fivetran_connector_sdk/protos/common_pb2.pyi,sha256=S0hdIzoXyyOKD5cjiGeDDLYpQ9J3LjAvu4rCj1JvJWE,9038
@@ -6,8 +6,8 @@ fivetran_connector_sdk/protos/common_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXH
 fivetran_connector_sdk/protos/connector_sdk_pb2.py,sha256=9Ke_Ti1s0vAeXapfXT-EryrT2-TSGQb8mhs4gxTpUMk,7732
 fivetran_connector_sdk/protos/connector_sdk_pb2.pyi,sha256=FWYxRgshEF3QDYAE0TM_mv4N2gGvkxCH_uPpxnMc4oA,8406
 fivetran_connector_sdk/protos/connector_sdk_pb2_grpc.py,sha256=ZfJLp4DW7uP4pFOZ74s_wQ6tD3eIPi-08UfnLwe4tzo,7163
-fivetran_connector_sdk-0.8.12.1.dist-info/METADATA,sha256=nZR69biAGw0z-EXCSUTcXXWcIpx1BkkNLQW3RukPAOY,708
-fivetran_connector_sdk-0.8.12.1.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-fivetran_connector_sdk-0.8.12.1.dist-info/entry_points.txt,sha256=uQn0KPnFlQmXJfxlk0tifdNsSXWfVlnAFzNqjXZM_xM,57
-fivetran_connector_sdk-0.8.12.1.dist-info/top_level.txt,sha256=-_xk2MFY4psIh7jw1lJePMzFb5-vask8_ZtX-UzYWUI,23
-fivetran_connector_sdk-0.8.12.1.dist-info/RECORD,,
+fivetran_connector_sdk-0.8.19.1.dist-info/METADATA,sha256=fgkWljNC3yuszXoF9mo6HGx2mw8KvKLAhf6G5uMuxHs,708
+fivetran_connector_sdk-0.8.19.1.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
+fivetran_connector_sdk-0.8.19.1.dist-info/entry_points.txt,sha256=uQn0KPnFlQmXJfxlk0tifdNsSXWfVlnAFzNqjXZM_xM,57
+fivetran_connector_sdk-0.8.19.1.dist-info/top_level.txt,sha256=-_xk2MFY4psIh7jw1lJePMzFb5-vask8_ZtX-UzYWUI,23
+fivetran_connector_sdk-0.8.19.1.dist-info/RECORD,,

{fivetran_connector_sdk-0.8.12.1.dist-info → fivetran_connector_sdk-0.8.19.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (72.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any