brynq-sdk-brynq 3.0.5__tar.gz → 4.0.1__tar.gz

{brynq_sdk_brynq-3.0.5 → brynq_sdk_brynq-4.0.1}/PKG-INFO

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

{brynq_sdk_brynq-3.0.5 → brynq_sdk_brynq-4.0.1}/brynq_sdk_brynq/brynq.py

@@ -19,6 +19,10 @@ class BrynQ:
         self.api_token = os.getenv("BRYNQ_API_TOKEN", api_token)
         self.environment = os.getenv("BRYNQ_ENVIRONMENT", staging)
         self.timeout = 3600
+        self.data_interface_id = os.getenv("DATA_INTERFACE_ID")
+        if self.data_interface_id is None:
+            raise ValueError("BRYNQ_DATA_INTERFACE_ID environment variable is not set, you should use this class via the TaskScheduler or set the variable in your code with:"
+                             "os.environ['DATA_INTERFACE_ID'] = str(self.data_interface_id). This is better than setting it in your .env where you will have to change it when switching between interfaces.")
 
         if any([self.subdomain is None, self.api_token is None]):
             raise ValueError("Set the subdomain, api_token either in your .env file or provide the subdomain and api_token parameters")
@@ -28,7 +32,7 @@ class BrynQ:
             raise ValueError(f"Environment should be in {','.join(possible_environments)}")
 
         self.url = 'https://app.brynq-staging.com/api/v2/' if self.environment == 'dev' else 'https://app.brynq.com/api/v2/'
-        
+
         # Initialize session with retry strategy. This is called brynq_session and not session as to not conflict with other SDKs that use self.session
         self.brynq_session = requests.Session()
         retry_strategy = Retry(
@@ -40,7 +44,7 @@ class BrynQ:
         self.brynq_session.mount("http://", adapter)
         self.brynq_session.mount("https://", adapter)
         self.brynq_session.headers.update(self._get_headers())
-        
+
         # Initialize components
         self.users = Users(self)
         self.organization_chart = OrganizationChart(self)
@@ -55,7 +59,7 @@ class BrynQ:
             'Domain': self.subdomain
         }
 
-    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:
+    def get_mapping(self, mapping: str, return_format: Literal['input_as_key', 'columns_names_as_keys', 'nested_input_output'] = 'input_as_key') -> dict:
         """
         DEPRECATED: Use brynq.mappings.get_mapping() instead
         """
@@ -72,7 +76,7 @@ class BrynQ:
         :return: The json of the mapping
         """
         # Find the mapping for the given sheet name
-        mappings = self.interfaces.mappings._get_mappings(interface_id=data_interface_id)
+        mappings = self.interfaces.mappings._get_mappings()
         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")
@@ -107,7 +111,7 @@ class BrynQ:
 
         return final_mapping
 
-    def get_mapping_as_dataframe(self, data_interface_id: int, mapping: str, prefix: bool = False) -> pd.DataFrame:
+    def get_mapping_as_dataframe(self, mapping: str, prefix: bool = False) -> pd.DataFrame:
         """
         DEPRECATED: Use brynq.mappings.get_mapping_as_dataframe() instead
         """
@@ -123,7 +127,7 @@ class BrynQ:
         :return: The dataframe of the mapping
         """
         # Find the mapping for the given sheet name
-        mappings = self.interfaces.mappings._get_mappings(interface_id=data_interface_id)
+        mappings = self.interfaces.mappings._get_mappings()
         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")
@@ -150,6 +154,7 @@ class BrynQ:
         df = pd.DataFrame(rows)
 
         return df
+
     def get_system_credential(self, system: str, label: Union[str, list], test_environment: bool = False) -> dict:
         """
         DEPRECATED: Use brynq.credentials.get() instead
@@ -161,7 +166,7 @@ class BrynQ:
         )
         return self.interfaces.credentials.get_system_credential(system, label, test_environment)
 
-    def get_interface_credential(self, interface_id: str, system: str, system_type: Optional[str] = None,
+    def get_interface_credential(self, system: str, system_type: Optional[str] = None,
                                  test_environment: bool = False) -> Union[dict, List[dict]]:
         """
         DEPRECATED: Use brynq.credentials.get_interface_credential() instead
@@ -171,7 +176,7 @@ class BrynQ:
             DeprecationWarning,
             stacklevel=2
         )
-        return self.interfaces.credentials.get(interface_id, system, system_type, test_environment)
+        return self.interfaces.credentials.get(self.data_interface_id, system, system_type, test_environment)
 
     def get_user_data(self):
         """

{brynq_sdk_brynq-3.0.5 → brynq_sdk_brynq-4.0.1}/brynq_sdk_brynq/credentials.py

@@ -47,7 +47,7 @@ class Credentials:
 
         return credentials[0]
 
-    def get(self,interface_id: str, system: str,system_type: Optional[str] = None,test_environment: bool = False) -> Union[dict, List[dict]]:
+    def get(self, system: str, system_type: Optional[str] = None, test_environment: bool = False) -> Union[dict, List[dict]]:
         """
         This method retrieves authentication credentials from BrynQ for a specific interface and system.
         
@@ -60,7 +60,7 @@ class Credentials:
         """
         
         # Fetch the config using a separate method
-        config = self._fetch_config(interface_id)
+        config = self._fetch_config()
 
         matching_credentials = []
 
@@ -129,7 +129,7 @@ class Credentials:
             warnings.warn(warning_msg)
             return [cred['credential'] for cred in matching_credentials]
 
-    def _fetch_config(self, interface_id: str) -> Dict[str, Any]:
+    def _fetch_config(self) -> Dict[str, Any]:
         """
         Fetch configuration from BrynQ for a given interface ID.
 
@@ -144,7 +144,7 @@ class Credentials:
             requests.exceptions.RequestException: If the API request fails.
         """
         response = self._brynq.brynq_session.get(
-            url=f'{self._brynq.url}interfaces/{interface_id}/config/auth',
+            url=f'{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/auth',
             timeout=self._brynq.timeout
         )
         response.raise_for_status()

{brynq_sdk_brynq-3.0.5 → brynq_sdk_brynq-4.0.1}/brynq_sdk_brynq/interfaces.py

@@ -19,7 +19,7 @@ class Interfaces:
         self.credentials = Credentials(brynq_instance)
         self.mappings = Mappings(brynq_instance)
 
-    def get(self) -> List[Dict[str, Any]]:
+    def get_all(self) -> List[Dict[str, Any]]:
         """Get all interfaces this token has access to.
         
         Returns:
@@ -48,12 +48,8 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid interface data received from API: {str(e)}")
 
-    def get_by_id(self, interface_id: int) -> Dict[str, Any]:
+    def get(self) -> Dict[str, Any]:
         """Get a specific interface by its ID.
-        
-        Args:
-            interface_id (int): The ID of the interface to retrieve
-            
         Returns:
             Dict[str, Any]: Interface details including:
                 - name (str): Interface name
@@ -67,11 +63,9 @@ class Interfaces:
             requests.exceptions.RequestException: If the API request fails
         """
         # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
 
         response = self._brynq.brynq_session.get(
-            f"{self._brynq.url}interfaces/{interface_id}",
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}",
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
@@ -83,7 +77,7 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid interface data received from API: {str(e)}")
 
-    def get_config(self, interface_id: int) -> Dict[str, Any]:
+    def get_config(self) -> Dict[str, Any]:
         """Get the base configuration of an interface.
         
         Args:
@@ -99,11 +93,9 @@ class Interfaces:
             requests.exceptions.RequestException: If the API request fails
         """
         # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
 
         response = self._brynq.brynq_session.get(
-            f"{self._brynq.url}interfaces/{interface_id}/config",
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config",
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
@@ -115,13 +107,10 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid interface configuration data: {str(e)}")
 
-    def flush_config(self, interface_id: int) -> Dict[str, Any]:
+    def flush_config(self) -> Dict[str, Any]:
         """
         Flushes the interface config to revert to a fresh state.
-        
-        Args:
-            interface_id: The ID of the interface
-            
+
         Returns:
             Dict[str, Any]: Response from the flush operation
             
@@ -129,38 +118,15 @@ class Interfaces:
             requests.exceptions.RequestException: If the API request fails
         """
         response = self._brynq.brynq_session.get(
-            url=f'{self._brynq.url}interfaces/{interface_id}/config/flush',
+            url=f'{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/flush',
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
         return response
 
-    def get_dataflows(self, interface_id: int) -> Dict[str, Any]:
-        """
-        Get the dataflows configuration of an interface.
-        
-        Args:
-            interface_id: The ID of the interface
-            
-        Returns:
-            Dict[str, Any]: Dataflows configuration
-            
-        Raises:
-            requests.exceptions.RequestException: If the API request fails
-        """
-        response = self._brynq.brynq_session.get(
-            url=f'{self._brynq.url}interfaces/{interface_id}/config/dataflows',
-            timeout=self._brynq.timeout
-        )
-        response.raise_for_status()
-        return response.json()
-
-    def get_schedule(self, interface_id: int) -> Dict[str, Any]:
+    def get_schedule(self) -> Dict[str, Any]:
         """Get the schedule configuration of an interface.
-        
-        Args:
-            interface_id (int): The ID of the interface
-            
+
         Returns:
             Dict[str, Any]: Schedule configuration including:
                 - id (int): The schedule ID
@@ -177,12 +143,8 @@ class Interfaces:
             ValueError: If interface_id is not a positive integer or if the response data is invalid
             requests.exceptions.RequestException: If the API request fails
         """
-        # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
-
         response = self._brynq.brynq_session.get(
-            f"{self._brynq.url}interfaces/{interface_id}/config/schedule",
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/schedule",
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
@@ -194,13 +156,10 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid schedule configuration data: {str(e)}")
 
-    def get_template_config(self, interface_id: int) -> Dict[str, Any]:
+    def get_template_config(self) -> Dict[str, Any]:
         """
         Get the template configuration of an interface.
-        
-        Args:
-            interface_id: The ID of the interface
-            
+
         Returns:
             Dict[str, Any]: Template configuration
             
@@ -208,18 +167,15 @@ class Interfaces:
             requests.exceptions.RequestException: If the API request fails
         """
         response = self._brynq.brynq_session.get(
-            url=f'{self._brynq.url}interfaces/{interface_id}/template-config',
+            url=f'{self._brynq.url}interfaces/{self._brynq.data_interface_id}/template-config',
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
         return response.json()
 
-    def get_scope(self, interface_id: int) -> Dict[str, Any]:
+    def get_scope(self) -> Dict[str, Any]:
         """Get live and draft scopes from interface by id.
-        
-        Args:
-            interface_id (int): The ID of the interface
-            
+
         Returns:
             Dict[str, Any]: Scope configuration including:
                 - live (Dict, optional): Live scope configuration
@@ -229,12 +185,8 @@ class Interfaces:
             ValueError: If interface_id is not a positive integer or if the response data is invalid
             requests.exceptions.RequestException: If the API request fails
         """
-        # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
-
         response = self._brynq.brynq_session.get(
-            f"{self._brynq.url}interfaces/{interface_id}/scope",
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/scope",
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
@@ -246,12 +198,9 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid scope data: {str(e)}")
 
-    def get_dev_settings(self, interface_id: int) -> List[dict[str,Any]]:
+    def get_dev_settings(self) -> List[dict[str,Any]]:
         """Get the dev-settings of an interface
 
-        Args:
-            interface_id: Numeric ID of the interface
-
         Returns:
             Dict[str, Any]: A dictionary containing the dev settings:
                 - dockerImage (str): Docker image name
@@ -264,14 +213,36 @@ class Interfaces:
             requests.exceptions.HTTPError: If dev settings not found (404)
             ValueError: If interface_id is not a positive integer
         """
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
 
         response = self._brynq.brynq_session.get(
-            url=f"{self._brynq.url}interfaces/{interface_id}/config/dev-settings",
+            url=f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/dev-settings",
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
         
         valid_data, _ = Functions.validate_pydantic_data(response.json(), schema=DevSettings)
         return valid_data
+
+    def get_variables(self, variable_name: str = None):
+        """
+        Get a value from the task_variables table corresponding with the given name. If temp value is filled, it will
+        (run_instant = 1), then the temp_value will be returned. This is to give the possibility for users in the frontend to run
+        a task once manual with other values then normal without overwriting the normal values.
+        :param variable_name: the name of the variable
+        :return: the value of the given variable.
+        """
+
+        variables = self.get_config().get("variables")
+
+        if not variables:
+            raise Exception(f"There are no valid variables in interface '{self._brynq.data_interface_id}'")
+
+        if variable_name:
+            variable = variables.get(variable_name)
+            if not variable:
+                raise Exception(f"The variable '{variable_name}' does not exist in interface '{self._brynq.data_interface_id}'")
+            self.flush_config()
+            return variable
+        else:
+            self.flush_config()
+            return variables

{brynq_sdk_brynq-3.0.5 → brynq_sdk_brynq-4.0.1}/brynq_sdk_brynq/mappings.py

@@ -22,7 +22,7 @@ class Mappings:
         """
         self._brynq = brynq_instance
 
-    def _get_mappings(self, interface_id: int) -> List[Dict[str, Any]]:
+    def _get_mappings(self) -> List[Dict[str, Any]]:
         """Get all mappings for an interface.
 
         Args:
@@ -35,12 +35,8 @@ class Mappings:
             ValueError: If interface_id is not a positive integer or if the response data is invalid
             requests.exceptions.RequestException: If the API request fails
         """
-        # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
-
         response = self._brynq.brynq_session.get(
-            f"{self._brynq.url}interfaces/{interface_id}/config/mapping",
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/mapping",
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
@@ -73,7 +69,7 @@ class Mappings:
             mappings[input_key] = output_value
         return mappings
 
-    def get(self, interface_id: int, mapping: str, as_df: bool = False, prefix: bool = False) -> dict:
+    def get(self, mapping: str, as_df: bool = False, prefix: bool = False) -> dict:
         """Get the mapping from BrynQ.
 
         Args:
@@ -91,7 +87,7 @@ class Mappings:
             MappingNotFoundError: If mapping is not found
             ValueError: If mapping data is invalid
         """
-        mappings = self._get_mappings(interface_id=interface_id)
+        mappings = self._get_mappings()
         mapping_data = next((item for item in mappings if item['name'] == mapping), None)
 
         if not mapping_data:

{brynq_sdk_brynq-3.0.5 → brynq_sdk_brynq-4.0.1}/brynq_sdk_brynq.egg-info/PKG-INFO

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

{brynq_sdk_brynq-3.0.5 → brynq_sdk_brynq-4.0.1}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_brynq',
-    version='3.0.5',
+    version='4.0.1',
     description='BrynQ SDK for the BrynQ.com platform',
     long_description='BrynQ SDK for the BrynQ.com platform',
     author='BrynQ',