brynq-sdk-brynq 1.0.1__tar.gz → 1.1.0__tar.gz

{brynq_sdk_brynq-1.0.1 → brynq_sdk_brynq-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_brynq
-Version: 1.0.1
+Version: 1.1.0
 Summary: BrynQ SDK for the BrynQ.com platform
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_brynq-1.0.1 → brynq_sdk_brynq-1.1.0}/brynq_sdk/brynq/brynq.py

@@ -2,7 +2,7 @@ import os
 import requests
 import json
 import pandas as pd
-from typing import Union
+from typing import Union, Literal
 
 
 class BrynQ:
@@ -26,55 +26,61 @@ class BrynQ:
             'Domain': self.subdomain
         }
 
-    def _get_mappings(self, task_id: int) -> dict:
+    def _get_mappings(self, data_interface_id: int) -> dict:
         """
         Get the mappings from the task in BrynQ
-        :param task_id: The id of the task in BrynQ. this does not have to be the task id of the current task
+        :param data_interface_id: The id of the data_interface in BrynQ. this does not have to be the task id of the current task
         :return: A dictionary with the following structure: {mapping_title: {tuple(input): output}}
         """
-        response = requests.get(url=f'{self.url}interfaces/{task_id}/data-mapping', headers=self._get_headers())
-
+        response = requests.get(url=f'{self.url}interfaces/{data_interface_id}/data-mapping', headers=self._get_headers())
         if response.status_code != 200:
             raise ValueError(f'Error occurred while fetching mappings: {response.text}. Please always check if you have added BRYNQ_SUBDOMAIN to your .env file')
 
         return response.json()
 
-    def get_mapping(self, task_id: int, mapping: str, multiple_values: str = 'raise'):
+    def get_mapping(self, data_interface_id: int, mapping: str, return_format: Literal['input_as_key', 'columns_names_as_keys', 'nested_input_output'] = 'input_as_key') -> dict:
         """
         Get the mapping json from the mappings
-        :param task_id: The id of the task in BrynQ. this does not have to be the task id of the current task
+        :param data_interface_id: The id of the task in BrynQ. this does not have to be the task id of the current task
         :param mapping: The name of the mapping
-        :param multiple_values: A string to indicate how to handle multiple input or output values. Options are 'raise' and 'concat'
+        :param return_format: Determines how the mapping should be returned. Options are 'input_as_key' (Default, the input column is the key, the output columns are the values), 'columns_names_as_keys', 'nested_input_output'
         :return: The json of the mapping
         """
         # Find the mapping for the given sheet name
-        mappings = self._get_mappings(task_id=task_id)
+        mappings = self._get_mappings(data_interface_id=data_interface_id)
         mapping_data = next((item for item in mappings if item['name'] == mapping), None)
         if not mapping_data:
             raise ValueError(f"Mapping named '{mapping}' not found")
 
-        result_mapping = {}
-        for value in mapping_data['values']:
-            if multiple_values == 'raise' and (len(value['input'].items()) > 1 or len(value['output'].items()) > 1):
-                raise ValueError("Multiple input or output keys found when 'raise' strategy is specified.")
-
-            input_values = []
-            output_values = []
-            for _, val in value['input'].items():
-                input_values.append(val)
-            for _, val in value['output'].items():
-                output_values.append(val)
-
-            if multiple_values == 'concat':
-                concatenated_input = ','.join(input_values)
-                concatenated_output = ','.join(output_values)
-                result_mapping[concatenated_input] = concatenated_output
-            else:  # Default to assuming there's only one key-value pair if not concatenating
-                result_mapping[input_values[0]] = output_values[0]
-
-        return result_mapping
-
-    def get_mapping_as_dataframe(self, task_id: int, mapping: str, prefix: bool = False):
+        # If the user want to get the column names back as keys, transform the data accordingly and return
+        if return_format == 'columns_names_as_keys':
+            final_mapping = []
+            for row in mapping_data['values']:
+                combined_dict = {}
+                combined_dict.update(row['input'])
+                combined_dict.update(row['output'])
+                final_mapping.append(combined_dict)
+        elif return_format == 'nested_input_output':
+            final_mapping = mapping_data
+        else:
+            final_mapping = {}
+            for value in mapping_data['values']:
+                input_values = []
+                output_values = []
+                for _, val in value['input'].items():
+                    input_values.append(val)
+                for _, val in value['output'].items():
+                    output_values.append(val)
+                # Detect if there are multiple input or output columns and concatenate them
+                if len(value['input'].items()) > 1 or len(value['output'].items()) > 1:
+                    concatenated_input = ','.join(input_values)
+                    concatenated_output = ','.join(output_values)
+                    final_mapping[concatenated_input] = concatenated_output
+                else:  # Default to assuming there's only one key-value pair if not concatenating
+                    final_mapping[input_values[0]] = output_values[0]
+        return final_mapping
+
+    def get_mapping_as_dataframe(self, data_interface_id: int, mapping: str, prefix: bool = False):
         """
         Get the mapping dataframe from the mappings
         :param mapping: The name of the mapping
@@ -82,7 +88,7 @@ class BrynQ:
         :return: The dataframe of the mapping
         """
         # Find the mapping for the given sheet name
-        mappings = self._get_mappings(task_id=task_id)
+        mappings = self._get_mappings(data_interface_id=data_interface_id)
         mapping_data = next((item for item in mappings if item['name'] == mapping), None)
         if not mapping_data:
             raise ValueError(f"Mapping named '{mapping}' not found")

{brynq_sdk_brynq-1.0.1 → brynq_sdk_brynq-1.1.0}/brynq_sdk_brynq.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-brynq
-Version: 1.0.1
+Version: 1.1.0
 Summary: BrynQ SDK for the BrynQ.com platform
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_brynq-1.0.1 → brynq_sdk_brynq-1.1.0}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup
 
 setup(
     name='brynq_sdk_brynq',
-    version='1.0.1',
+    version='1.1.0',
     description='BrynQ SDK for the BrynQ.com platform',
     long_description='BrynQ SDK for the BrynQ.com platform',
     author='BrynQ',