hana-cloud-interface 0.3.0__py3-none-any.whl

hana_cloud_interface/__init__.py

@@ -0,0 +1 @@
+from .main import Hana_cloud_interface

hana_cloud_interface/main.py

@@ -0,0 +1,337 @@
+import time
+import threading
+import datetime
+
+from selenium import webdriver
+from selenium.webdriver.chrome.options import Options
+
+import pandas as pd
+import polars as pl
+
+import requests
+
+from hdbcli import dbapi
+from hana_ml.dataframe import ConnectionContext, create_dataframe_from_pandas
+
+from platformdirs import *
+import os
+import json
+
+
+
+
+class Hana_cloud_interface:
+    def __init__(self,config=None, df=None):
+        """
+        Initialize the Hana_cloud_interface class.
+
+        Args:
+            config (str, optional): Path to the configuration JSON file. If provided and valid, the configuration will be loaded and saved to the user data directory.
+            df (str, optional): DataFrame type to use for query results ('pandas' or 'polars'). Can be overridden per query.
+
+        Raises:
+            Exception: If the provided config path does not exist.
+        """
+        self.DF_type_global_override = df
+        
+        # set up app data location if it doesn't exist
+        appname = "HanaCloudinterface"
+        appauthor = "powerco"
+        self.app_data_location =user_data_dir(appname, appauthor)
+        os.makedirs(self.app_data_location, exist_ok=True)
+        
+        
+        
+        # read to config file and saves it to user data location
+        if config is not None:
+            if os.path.exists(config):
+                with open(config, 'r') as f:
+                    dictionary = json.load(f)
+                file_path = os.path.join(self.app_data_location, ('token.json')) 
+                with open(file_path, 'w') as f:
+                    json.dump(dictionary, f)
+            else:
+                raise Exception('path to configuration file not valid')
+
+    def _save_json(self,type,dictionary):
+        """
+        Save a dictionary as a JSON file in the application data directory.
+
+        Args:
+            type (str): The type of file to save ('config' or 'token').
+            dictionary (dict): The dictionary to save as JSON.
+
+        Raises:
+            ValueError: If the type is not 'config' or 'token'.
+        """
+        # Save password dictionary as JSON in the config_location folder
+        if type == 'config':
+            file_path = os.path.join(self.app_data_location, ('config.json'))
+        elif type == 'token':
+            file_path = os.path.join(self.app_data_location, ('token.json')) 
+        else:
+            raise ValueError("type must be either 'config' or 'token'")
+        with open(file_path, 'w') as f:
+            json.dump(dictionary, f)
+
+
+    def _read_json(self):
+        """
+        Read the configuration and token JSON files from the application data directory.
+
+        Returns:
+            list: A list containing two elements:
+            - The configuration dictionary if found, otherwise None.
+            - The token dictionary if found, otherwise None.
+        """
+        
+        file_path_1 = os.path.join(self.app_data_location, ('config.json'))
+        file_path_2 = os.path.join(self.app_data_location, ('token.json'))
+        out = [None,None]
+        if os.path.exists(file_path_1):
+            with open(file_path_1, 'r') as f:
+                out[0] = json.load(f)
+        if os.path.exists(file_path_2):
+            with open(file_path_2, 'r') as f:
+                out[1] = json.load(f)
+        return out
+
+    def _get_token(self,oauth_config):   
+        """
+        Obtain an OAuth token using the provided OAuth configuration.
+
+        Args:
+            oauth_config (dict): A dictionary containing OAuth configuration parameters, including:
+                - CLIENT_ID
+                - CLIENT_SECRET
+                - REDIRECT_URI
+                - AUTH_URL
+                - TOKEN_URL
+                - SCOPE
+
+        Returns:
+            dict: The token data obtained from the OAuth server, including access token, refresh token, and time obtained.
+
+        Raises:
+            Exception: If the token cannot be obtained due to an HTTP error or invalid configuration.
+        """
+        
+        import urllib.parse
+        params = {
+        'response_type': 'code',
+        'client_id': oauth_config['CLIENT_ID'],
+        'redirect_uri': oauth_config['REDIRECT_URI'],
+        'scope': oauth_config['SCOPE']
+        }
+        authorization_url = f"{oauth_config['AUTH_URL']}?{urllib.parse.urlencode(params)}"
+
+
+        # Define a specific directory for your profile data
+        # (Ensure this directory exists before running the script)
+        profile_dir = os.path.join(self.app_data_location, "selenium_profile")
+        print('Profile directory:', profile_dir)
+        if not os.path.exists(profile_dir):
+            os.makedirs(profile_dir)
+
+        chrome_options = Options()
+        # Use 'user-data-dir' to save/load the entire profile
+        chrome_options.add_argument(f"--user-data-dir={profile_dir}")
+        # Optional: Specify a specific profile within that directory (e.g., "Default" or "Profile 1")
+        chrome_options.add_argument("--profile-directory=Default") 
+
+        driver = webdriver.Chrome(options=chrome_options)
+        driver.get(authorization_url)
+
+
+        while not driver.current_url.startswith("http://localhost:8080/callback"):
+            time.sleep(0.1)
+        print("Callback URL reached:", driver.current_url)
+        query_components = urllib.parse.parse_qs(urllib.parse.urlparse(driver.current_url).query)
+        authorization_code = query_components.get('code')
+
+
+        threading.Thread(target=driver.quit).start()
+
+        print('Authorization code:', authorization_code)
+
+
+        payload = {
+            'grant_type': 'authorization_code',
+            'code': authorization_code,
+            'redirect_uri': oauth_config['REDIRECT_URI'],
+            'client_id': oauth_config['CLIENT_ID'],
+            'client_secret': oauth_config['CLIENT_SECRET']
+        }
+        response = requests.post(oauth_config['TOKEN_URL'], data=payload)
+        if response.status_code == 200:
+            token_data = response.json()
+            token_data['time_obtained'] = time.time()
+        else:
+            raise Exception(f"Failed to obtain access token: {response.status_code} {response.text}")   
+        
+        self._save_json('token',token_data)
+        return token_data
+
+    def _refresh_access_token(self,token_data,oauth_config): 
+        """
+        Refresh the OAuth access token using the refresh token.
+        if the refresh fails it will get a new token
+
+        Args:
+            token_data (dict): The current token data containing at least the 'refresh_token'.
+            oauth_config (dict): The OAuth configuration dictionary with required client and endpoint information.
+
+        Returns:
+            dict: The refreshed token data, including the new access token and updated 'time_obtained'.
+
+        """
+        token_url = oauth_config['TOKEN_URL']
+        # Set up the request payload
+        payload = {
+            'grant_type': 'refresh_token',
+            'client_id': oauth_config['CLIENT_ID'],
+            'client_secret': oauth_config['CLIENT_SECRET'],
+            'refresh_token': token_data['refresh_token']
+        }
+        # Make the request to the token endpoint
+        response = requests.post(token_url, data=payload)
+
+        # Check if the request was successful
+        if response.status_code == 200:
+            token_data = response.json()
+            token_data['time_obtained'] = time.time()
+            self._save_json('token',token_data)
+        else:
+            print('Failed to refresh token, obtaining new token')
+            print('response:',response.status_code,response.text)
+            token_data = self._get_token(oauth_config)
+            
+        return token_data
+        
+    def _connect_to_hana(self):
+        """
+        Establish a connection to the HANA Cloud database using OAuth authentication.
+
+        This method reads the OAuth configuration and token data from JSON files in the application data directory.
+        If the token is missing or expired, it obtains or refreshes the token as needed.
+        Returns a database cursor for executing SQL commands.
+
+        Returns:
+            hdbcli.dbapi.Cursor: A cursor object connected to the HANA Cloud database.
+
+        Raises:
+            Exception: If the configuration file is missing or invalid.
+        """
+        oauth_config,token_data = self._read_json()
+        if oauth_config is None:
+            raise Exception('No config file found, please run configuration first')
+        elif token_data is None:
+            token_data = self._get_token(oauth_config)
+
+
+        expiry_timestamp = token_data['time_obtained'] + token_data['expires_in']
+        expiry_datetime = datetime.datetime.fromtimestamp(expiry_timestamp)
+        print("Token expires at:", expiry_datetime)
+        # Refresh token if it will expire in less than 20 minutes (1200 seconds)
+
+        if time.time() > expiry_timestamp:
+            print('Token has expired, obtaining new token')
+            token_data = self._get_token(oauth_config)
+        elif expiry_timestamp - time.time() < 1200:
+            print('Token will expire in less than 20 minutes, refreshing token')
+            token_data = self._refresh_access_token(token_data, oauth_config)
+            
+        return  dbapi.connect(address=oauth_config['HC_prod_URL'],port='443',authenticationMethods='jwt',password=token_data['access_token'],encrypt=True, sslValidateCertificate=True).cursor()
+
+    def hana_sql(self, sql_command='validate',DF_type_local_override = None):
+        """
+        Execute a SQL command on the HANA Cloud database and return the result as a DataFrame.
+
+        Args:
+            sql_command (str, optional): The SQL command to execute. Defaults to 'validate', which only checks the connection.
+            DF_type_local_override (str, optional): DataFrame type for this query ('pandas' or 'polars'). Overrides the global setting if provided.
+
+        Returns:
+            str: If sql_command is 'validate', returns a validation message.
+            pandas.DataFrame or polars.DataFrame: The query result as a DataFrame, depending on the specified or default DataFrame type.
+
+        Raises:
+            ValueError: If the DataFrame type is not specified or is invalid.
+        """
+        
+        cursor = self._connect_to_hana()
+        if sql_command == 'validate':
+            return 'Connection successful validated'
+        
+        if DF_type_local_override is not None:
+            DF_type = DF_type_local_override
+        else:
+            DF_type = self.DF_type_global_override
+            
+        cursor.execute(sql_command) # Run SQL command
+        # Retrieve data and convert it to a pandas data frame
+        data = cursor.fetchall() 
+        data_name = [i[0] for i in cursor.description] 
+        cursor.close() 
+        
+        if DF_type == 'pandas':
+
+            return pd.DataFrame(data,columns=data_name)
+        elif DF_type == 'polars':
+            data = [row.column_values for row in data]
+            return pl.DataFrame(data,orient='row',schema=data_name)
+        else:
+            raise ValueError("DF_type must be either 'pandas' or 'polars' needs to be defined when you initialise the class or pass it to the hana_sql function")
+        
+        
+    def hana_upload(self,data, data_name, SCHEMA):
+        """
+        Upload a DataFrame to the HANA Cloud database.
+
+        Args:
+            data (pandas.DataFrame or polars.DataFrame): The data to upload. If a polars DataFrame is provided, it will be converted to pandas.
+            data_name (str): The name of the table to create or replace in HANA Cloud.
+            SCHEMA (str): The schema in which to create the table.
+
+        Returns:
+            bool: True if the upload is successful.
+
+        Raises:
+            Exception: If the upload fails due to connection or data issues.
+        """
+        
+        # If the input data is a polars DataFrame, convert it to pandas
+        if isinstance(data, pl.DataFrame):
+            data = data.to_pandas()
+
+
+        # validates that the token still works
+        cursor = self._connect_to_hana()
+        cursor.close()
+
+        oauth_config,token_data = self._read_json()
+        
+        conn = ConnectionContext(address=oauth_config['HC_prod_URL'],port='443',authenticationMethods='jwt',password=token_data['access_token'],encrypt=True, sslValidateCertificate=True) 
+
+        create_dataframe_from_pandas(conn, data, data_name,
+                                    schema=SCHEMA, 
+                                    force=True, # True: truncate and insert
+                                    replace=True) # True: Null is replaced by 0
+        return True
+    
+def validate():
+    """
+    Validate the connection to the HANA Cloud database.
+
+    This function creates an instance of the Hana_cloud_interface class and calls the hana_sql method
+    with the 'validate' command to check the connection.
+
+    Returns:
+        str: A message indicating whether the connection was successful or failed.
+    """
+    hana_interface = Hana_cloud_interface()
+    try:
+        result = hana_interface.hana_sql('validate')
+        return result
+    except Exception as e:
+        return f'Connection failed: {str(e)}'

hana_cloud_interface/test_doc.ipynb

@@ -0,0 +1,652 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1b2ba115",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import time\n",
+    "import threading\n",
+    "import datetime\n",
+    "\n",
+    "from selenium import webdriver\n",
+    "from selenium.webdriver.chrome.options import Options\n",
+    "\n",
+    "import pandas as pd\n",
+    "import polars as pl\n",
+    "\n",
+    "import requests\n",
+    "\n",
+    "from hdbcli import dbapi\n",
+    "from hana_ml.dataframe import ConnectionContext, create_dataframe_from_pandas\n",
+    "\n",
+    "from platformdirs import *\n",
+    "import os\n",
+    "import json\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "class Hana_cloud_interface:\n",
+    "    def __init__(self,config=None, df=None):\n",
+    "        \"\"\"\n",
+    "        Initialize the Hana_cloud_interface class.\n",
+    "\n",
+    "        Args:\n",
+    "            config (str, optional): Path to the configuration JSON file. If provided and valid, the configuration will be loaded and saved to the user data directory.\n",
+    "            df (str, optional): DataFrame type to use for query results ('pandas' or 'polars'). Can be overridden per query.\n",
+    "\n",
+    "        Raises:\n",
+    "            Exception: If the provided config path does not exist.\n",
+    "        \"\"\"\n",
+    "        self.DF_type_global_override = df\n",
+    "        \n",
+    "        # set up app data location if it doesn't exist\n",
+    "        appname = \"HanaCloudinterface\"\n",
+    "        appauthor = \"powerco\"\n",
+    "        self.app_data_location =user_data_dir(appname, appauthor)\n",
+    "        os.makedirs(self.app_data_location, exist_ok=True)\n",
+    "        \n",
+    "        \n",
+    "        \n",
+    "        # read to config file and saves it to user data location\n",
+    "        if config is not None:\n",
+    "            if os.path.exists(config):\n",
+    "                with open(config, 'r') as f:\n",
+    "                    dictionary = json.load(f)\n",
+    "                file_path = os.path.join(self.app_data_location, ('token.json')) \n",
+    "                with open(file_path, 'w') as f:\n",
+    "                    json.dump(dictionary, f)\n",
+    "            else:\n",
+    "                raise Exception('path to configuration file not valid')\n",
+    "\n",
+    "    def _save_json(self,type,dictionary):\n",
+    "        \"\"\"\n",
+    "        Save a dictionary as a JSON file in the application data directory.\n",
+    "\n",
+    "        Args:\n",
+    "            type (str): The type of file to save ('config' or 'token').\n",
+    "            dictionary (dict): The dictionary to save as JSON.\n",
+    "\n",
+    "        Raises:\n",
+    "            ValueError: If the type is not 'config' or 'token'.\n",
+    "        \"\"\"\n",
+    "        # Save password dictionary as JSON in the config_location folder\n",
+    "        if type == 'config':\n",
+    "            file_path = os.path.join(self.app_data_location, ('config.json'))\n",
+    "        elif type == 'token':\n",
+    "            file_path = os.path.join(self.app_data_location, ('token.json')) \n",
+    "        else:\n",
+    "            raise ValueError(\"type must be either 'config' or 'token'\")\n",
+    "        with open(file_path, 'w') as f:\n",
+    "            json.dump(dictionary, f)\n",
+    "\n",
+    "\n",
+    "    def _read_json(self):\n",
+    "        \"\"\"\n",
+    "        Read the configuration and token JSON files from the application data directory.\n",
+    "\n",
+    "        Returns:\n",
+    "            list: A list containing two elements:\n",
+    "            - The configuration dictionary if found, otherwise None.\n",
+    "            - The token dictionary if found, otherwise None.\n",
+    "        \"\"\"\n",
+    "        \n",
+    "        file_path_1 = os.path.join(self.app_data_location, ('config.json'))\n",
+    "        file_path_2 = os.path.join(self.app_data_location, ('token.json'))\n",
+    "        out = [None,None]\n",
+    "        if os.path.exists(file_path_1):\n",
+    "            with open(file_path_1, 'r') as f:\n",
+    "                out[0] = json.load(f)\n",
+    "        if os.path.exists(file_path_2):\n",
+    "            with open(file_path_2, 'r') as f:\n",
+    "                out[1] = json.load(f)\n",
+    "        return out\n",
+    "\n",
+    "    def _get_token(self,oauth_config):   \n",
+    "        \"\"\"\n",
+    "        Obtain an OAuth token using the provided OAuth configuration.\n",
+    "\n",
+    "        Args:\n",
+    "            oauth_config (dict): A dictionary containing OAuth configuration parameters, including:\n",
+    "                - CLIENT_ID\n",
+    "                - CLIENT_SECRET\n",
+    "                - REDIRECT_URI\n",
+    "                - AUTH_URL\n",
+    "                - TOKEN_URL\n",
+    "                - SCOPE\n",
+    "\n",
+    "        Returns:\n",
+    "            dict: The token data obtained from the OAuth server, including access token, refresh token, and time obtained.\n",
+    "\n",
+    "        Raises:\n",
+    "            Exception: If the token cannot be obtained due to an HTTP error or invalid configuration.\n",
+    "        \"\"\"\n",
+    "        \n",
+    "        import urllib.parse\n",
+    "        params = {\n",
+    "        'response_type': 'code',\n",
+    "        'client_id': oauth_config['CLIENT_ID'],\n",
+    "        'redirect_uri': oauth_config['REDIRECT_URI'],\n",
+    "        'scope': oauth_config['SCOPE']\n",
+    "        }\n",
+    "        authorization_url = f\"{oauth_config['AUTH_URL']}?{urllib.parse.urlencode(params)}\"\n",
+    "\n",
+    "\n",
+    "        # Define a specific directory for your profile data\n",
+    "        # (Ensure this directory exists before running the script)\n",
+    "        profile_dir = os.path.join(self.app_data_location, \"selenium_profile\")\n",
+    "        print('Profile directory:', profile_dir)\n",
+    "        if not os.path.exists(profile_dir):\n",
+    "            os.makedirs(profile_dir)\n",
+    "\n",
+    "        chrome_options = Options()\n",
+    "        # Use 'user-data-dir' to save/load the entire profile\n",
+    "        chrome_options.add_argument(f\"--user-data-dir={profile_dir}\")\n",
+    "        # Optional: Specify a specific profile within that directory (e.g., \"Default\" or \"Profile 1\")\n",
+    "        chrome_options.add_argument(\"--profile-directory=Default\") \n",
+    "\n",
+    "        driver = webdriver.Chrome(options=chrome_options)\n",
+    "        driver.get(authorization_url)\n",
+    "\n",
+    "\n",
+    "        while not driver.current_url.startswith(\"http://localhost:8080/callback\"):\n",
+    "            time.sleep(0.1)\n",
+    "        print(\"Callback URL reached:\", driver.current_url)\n",
+    "        query_components = urllib.parse.parse_qs(urllib.parse.urlparse(driver.current_url).query)\n",
+    "        authorization_code = query_components.get('code')\n",
+    "\n",
+    "\n",
+    "        threading.Thread(target=driver.quit).start()\n",
+    "\n",
+    "        print('Authorization code:', authorization_code)\n",
+    "\n",
+    "\n",
+    "        payload = {\n",
+    "            'grant_type': 'authorization_code',\n",
+    "            'code': authorization_code,\n",
+    "            'redirect_uri': oauth_config['REDIRECT_URI'],\n",
+    "            'client_id': oauth_config['CLIENT_ID'],\n",
+    "            'client_secret': oauth_config['CLIENT_SECRET']\n",
+    "        }\n",
+    "        response = requests.post(oauth_config['TOKEN_URL'], data=payload)\n",
+    "        if response.status_code == 200:\n",
+    "            token_data = response.json()\n",
+    "            token_data['time_obtained'] = time.time()\n",
+    "        else:\n",
+    "            raise Exception(f\"Failed to obtain access token: {response.status_code} {response.text}\")   \n",
+    "        \n",
+    "        self._save_json('token',token_data)\n",
+    "        return token_data\n",
+    "\n",
+    "    def _refresh_access_token(self,token_data,oauth_config): \n",
+    "        \"\"\"\n",
+    "        Refresh the OAuth access token using the refresh token.\n",
+    "        if the refresh fails it will get a new token\n",
+    "\n",
+    "        Args:\n",
+    "            token_data (dict): The current token data containing at least the 'refresh_token'.\n",
+    "            oauth_config (dict): The OAuth configuration dictionary with required client and endpoint information.\n",
+    "\n",
+    "        Returns:\n",
+    "            dict: The refreshed token data, including the new access token and updated 'time_obtained'.\n",
+    "\n",
+    "        \"\"\"\n",
+    "        token_url = oauth_config['TOKEN_URL']\n",
+    "        # Set up the request payload\n",
+    "        payload = {\n",
+    "            'grant_type': 'refresh_token',\n",
+    "            'client_id': oauth_config['CLIENT_ID'],\n",
+    "            'client_secret': oauth_config['CLIENT_SECRET'],\n",
+    "            'refresh_token': token_data['refresh_token']\n",
+    "        }\n",
+    "        # Make the request to the token endpoint\n",
+    "        response = requests.post(token_url, data=payload)\n",
+    "\n",
+    "        # Check if the request was successful\n",
+    "        if response.status_code == 200:\n",
+    "            token_data = response.json()\n",
+    "            token_data['time_obtained'] = time.time()\n",
+    "            self._save_json('token',token_data)\n",
+    "        else:\n",
+    "            print('Failed to refresh token, obtaining new token')\n",
+    "            print('response:',response.status_code,response.text)\n",
+    "            token_data = self._get_token(oauth_config)\n",
+    "            \n",
+    "        return token_data\n",
+    "        \n",
+    "    def _connect_to_hana(self):\n",
+    "        \"\"\"\n",
+    "        Establish a connection to the HANA Cloud database using OAuth authentication.\n",
+    "\n",
+    "        This method reads the OAuth configuration and token data from JSON files in the application data directory.\n",
+    "        If the token is missing or expired, it obtains or refreshes the token as needed.\n",
+    "        Returns a database cursor for executing SQL commands.\n",
+    "\n",
+    "        Returns:\n",
+    "            hdbcli.dbapi.Cursor: A cursor object connected to the HANA Cloud database.\n",
+    "\n",
+    "        Raises:\n",
+    "            Exception: If the configuration file is missing or invalid.\n",
+    "        \"\"\"\n",
+    "        oauth_config,token_data = self._read_json()\n",
+    "        if oauth_config is None:\n",
+    "            raise Exception('No config file found, please run configuration first')\n",
+    "        elif token_data is None:\n",
+    "            token_data = self._get_token(oauth_config)\n",
+    "\n",
+    "\n",
+    "        expiry_timestamp = token_data['time_obtained'] + token_data['expires_in']\n",
+    "        expiry_datetime = datetime.datetime.fromtimestamp(expiry_timestamp)\n",
+    "        print(\"Token expires at:\", expiry_datetime)\n",
+    "        # Refresh token if it will expire in less than 20 minutes (1200 seconds)\n",
+    "\n",
+    "        if time.time() > expiry_timestamp:\n",
+    "            print('Token has expired, obtaining new token')\n",
+    "            token_data = self._get_token(oauth_config)\n",
+    "        elif expiry_timestamp - time.time() < 1200:\n",
+    "            print('Token will expire in less than 20 minutes, refreshing token')\n",
+    "            token_data = self._refresh_access_token(token_data, oauth_config)\n",
+    "            \n",
+    "        return  dbapi.connect(address=oauth_config['HC_prod_URL'],port='443',authenticationMethods='jwt',password=token_data['access_token'],encrypt=True, sslValidateCertificate=True).cursor()\n",
+    "\n",
+    "    def hana_sql(self, sql_command='validate',DF_type_local_override = None):\n",
+    "        \"\"\"\n",
+    "        Execute a SQL command on the HANA Cloud database and return the result as a DataFrame.\n",
+    "\n",
+    "        Args:\n",
+    "            sql_command (str, optional): The SQL command to execute. Defaults to 'validate', which only checks the connection.\n",
+    "            DF_type_local_override (str, optional): DataFrame type for this query ('pandas' or 'polars'). Overrides the global setting if provided.\n",
+    "\n",
+    "        Returns:\n",
+    "            str: If sql_command is 'validate', returns a validation message.\n",
+    "            pandas.DataFrame or polars.DataFrame: The query result as a DataFrame, depending on the specified or default DataFrame type.\n",
+    "\n",
+    "        Raises:\n",
+    "            ValueError: If the DataFrame type is not specified or is invalid.\n",
+    "        \"\"\"\n",
+    "        \n",
+    "        cursor = self._connect_to_hana()\n",
+    "        if sql_command == 'validate':\n",
+    "            return 'Connection successful validated'\n",
+    "        \n",
+    "        if DF_type_local_override is not None:\n",
+    "            DF_type = DF_type_local_override\n",
+    "        else:\n",
+    "            DF_type = self.DF_type_global_override\n",
+    "            \n",
+    "        cursor.execute(sql_command) # Run SQL command\n",
+    "        # Retrieve data and convert it to a pandas data frame\n",
+    "        data = cursor.fetchall() \n",
+    "        data_name = [i[0] for i in cursor.description] \n",
+    "        cursor.close() \n",
+    "        \n",
+    "        if DF_type == 'pandas':\n",
+    "\n",
+    "            return pd.DataFrame(data,columns=data_name)\n",
+    "        elif DF_type == 'polars':\n",
+    "            data = [row.column_values for row in data]\n",
+    "            return pl.DataFrame(data,orient='row',schema=data_name)\n",
+    "        else:\n",
+    "            raise ValueError(\"DF_type must be either 'pandas' or 'polars' needs to be defined when you initialise the class or pass it to the hana_sql function\")\n",
+    "        \n",
+    "        \n",
+    "    def hana_upload(self,data, data_name, SCHEMA):\n",
+    "        \"\"\"\n",
+    "        Upload a DataFrame to the HANA Cloud database.\n",
+    "\n",
+    "        Args:\n",
+    "            data (pandas.DataFrame or polars.DataFrame): The data to upload. If a polars DataFrame is provided, it will be converted to pandas.\n",
+    "            data_name (str): The name of the table to create or replace in HANA Cloud.\n",
+    "            SCHEMA (str): The schema in which to create the table.\n",
+    "\n",
+    "        Returns:\n",
+    "            bool: True if the upload is successful.\n",
+    "\n",
+    "        Raises:\n",
+    "            Exception: If the upload fails due to connection or data issues.\n",
+    "        \"\"\"\n",
+    "        \n",
+    "        # If the input data is a polars DataFrame, convert it to pandas\n",
+    "        if isinstance(data, pl.DataFrame):\n",
+    "            data = data.to_pandas()\n",
+    "\n",
+    "\n",
+    "        # validates that the token still works\n",
+    "        cursor = self._connect_to_hana()\n",
+    "        cursor.close()\n",
+    "\n",
+    "        oauth_config,token_data = self._read_json()\n",
+    "        \n",
+    "        conn = ConnectionContext(address=oauth_config['HC_prod_URL'],port='443',authenticationMethods='jwt',password=token_data['access_token'],encrypt=True, sslValidateCertificate=True) \n",
+    "\n",
+    "        create_dataframe_from_pandas(conn, data, data_name,\n",
+    "                                    schema=SCHEMA, \n",
+    "                                    force=True, # True: truncate and insert\n",
+    "                                    replace=True) # True: Null is replaced by 0\n",
+    "        return True"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "958cd124",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Token expires at: 2026-02-03 10:06:44.782597\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'Connection successful validated'"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "hci = Hana_cloud_interface()\n",
+    "hci.hana_sql()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "632c77a9",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Token expires at: 2026-02-02 19:15:41.178823\n"
+     ]
+    },
+    {
+     "data": {
+      "text/html": [
+       "<div><style>\n",
+       ".dataframe > thead > tr,\n",
+       ".dataframe > tbody > tr {\n",
+       "  text-align: right;\n",
+       "  white-space: pre-wrap;\n",
+       "}\n",
+       "</style>\n",
+       "<small>shape: (12, 2)</small><table border=\"1\" class=\"dataframe\"><thead><tr><th>POWERCO_FINANCIAL_YEAR</th><th>ICP_DAILY_COUNT_AVERAGE_YTD</th></tr><tr><td>str</td><td>i64</td></tr></thead><tbody><tr><td>&quot;2016-2017&quot;</td><td>333925</td></tr><tr><td>&quot;2023-2024&quot;</td><td>359939</td></tr><tr><td>&quot;2014-2015&quot;</td><td>326597</td></tr><tr><td>&quot;2021-2022&quot;</td><td>352685</td></tr><tr><td>&quot;2020-2021&quot;</td><td>347964</td></tr><tr><td>&hellip;</td><td>&hellip;</td></tr><tr><td>&quot;2025-2026&quot;</td><td>364634</td></tr><tr><td>&quot;2015-2016&quot;</td><td>330630</td></tr><tr><td>&quot;2022-2023&quot;</td><td>356743</td></tr><tr><td>&quot;2017-2018&quot;</td><td>336728</td></tr><tr><td>&quot;2019-2020&quot;</td><td>344040</td></tr></tbody></table></div>"
+      ],
+      "text/plain": [
+       "shape: (12, 2)\n",
+       "┌────────────────────────┬─────────────────────────────┐\n",
+       "│ POWERCO_FINANCIAL_YEAR ┆ ICP_DAILY_COUNT_AVERAGE_YTD │\n",
+       "│ ---                    ┆ ---                         │\n",
+       "│ str                    ┆ i64                         │\n",
+       "╞════════════════════════╪═════════════════════════════╡\n",
+       "│ 2016-2017              ┆ 333925                      │\n",
+       "│ 2023-2024              ┆ 359939                      │\n",
+       "│ 2014-2015              ┆ 326597                      │\n",
+       "│ 2021-2022              ┆ 352685                      │\n",
+       "│ 2020-2021              ┆ 347964                      │\n",
+       "│ …                      ┆ …                           │\n",
+       "│ 2025-2026              ┆ 364634                      │\n",
+       "│ 2015-2016              ┆ 330630                      │\n",
+       "│ 2022-2023              ┆ 356743                      │\n",
+       "│ 2017-2018              ┆ 336728                      │\n",
+       "│ 2019-2020              ┆ 344040                      │\n",
+       "└────────────────────────┴─────────────────────────────┘"
+      ]
+     },
+     "execution_count": 14,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "hci = Hana_cloud_interface(df='polars')\n",
+    "\n",
+    "\n",
+    "q = '''\n",
+    "    SELECT DISTINCT  \n",
+    "        \"POWERCO_FINANCIAL_YEAR\",\n",
+    "        \"ICPDAILYCOUNTAVERAGEYTD\" as \"ICP_DAILY_COUNT_AVERAGE_YTD\"\n",
+    "    FROM \"ZPUBLIC\".\"ZV_BW4_D_F_MDS_ICP_COUNT\"\n",
+    "    WHERE  (\"LATESTINFYDATEIND\" = '1' ) \n",
+    "'''\n",
+    "\n",
+    "hci.hana_sql(q)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "092fe8a5",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Token expires at: 2026-02-02 15:00:38.586668\n"
+     ]
+    },
+    {
+     "data": {
+      "text/html": [
+       "<div>\n",
+       "<style scoped>\n",
+       "    .dataframe tbody tr th:only-of-type {\n",
+       "        vertical-align: middle;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe tbody tr th {\n",
+       "        vertical-align: top;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe thead th {\n",
+       "        text-align: right;\n",
+       "    }\n",
+       "</style>\n",
+       "<table border=\"1\" class=\"dataframe\">\n",
+       "  <thead>\n",
+       "    <tr style=\"text-align: right;\">\n",
+       "      <th></th>\n",
+       "      <th>POWERCO_FINANCIAL_YEAR</th>\n",
+       "      <th>ICP_DAILY_COUNT_AVERAGE_YTD</th>\n",
+       "    </tr>\n",
+       "  </thead>\n",
+       "  <tbody>\n",
+       "    <tr>\n",
+       "      <th>0</th>\n",
+       "      <td>2016-2017</td>\n",
+       "      <td>333925</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>1</th>\n",
+       "      <td>2023-2024</td>\n",
+       "      <td>359939</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2</th>\n",
+       "      <td>2014-2015</td>\n",
+       "      <td>326597</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>3</th>\n",
+       "      <td>2021-2022</td>\n",
+       "      <td>352685</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>4</th>\n",
+       "      <td>2020-2021</td>\n",
+       "      <td>347964</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>5</th>\n",
+       "      <td>2018-2019</td>\n",
+       "      <td>340379</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>6</th>\n",
+       "      <td>2024-2025</td>\n",
+       "      <td>362455</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>7</th>\n",
+       "      <td>2025-2026</td>\n",
+       "      <td>364634</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>8</th>\n",
+       "      <td>2015-2016</td>\n",
+       "      <td>330630</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>9</th>\n",
+       "      <td>2022-2023</td>\n",
+       "      <td>356743</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>10</th>\n",
+       "      <td>2017-2018</td>\n",
+       "      <td>336728</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>11</th>\n",
+       "      <td>2019-2020</td>\n",
+       "      <td>344040</td>\n",
+       "    </tr>\n",
+       "  </tbody>\n",
+       "</table>\n",
+       "</div>"
+      ],
+      "text/plain": [
+       "   POWERCO_FINANCIAL_YEAR  ICP_DAILY_COUNT_AVERAGE_YTD\n",
+       "0               2016-2017                       333925\n",
+       "1               2023-2024                       359939\n",
+       "2               2014-2015                       326597\n",
+       "3               2021-2022                       352685\n",
+       "4               2020-2021                       347964\n",
+       "5               2018-2019                       340379\n",
+       "6               2024-2025                       362455\n",
+       "7               2025-2026                       364634\n",
+       "8               2015-2016                       330630\n",
+       "9               2022-2023                       356743\n",
+       "10              2017-2018                       336728\n",
+       "11              2019-2020                       344040"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "hci = Hana_cloud_interface()\n",
+    "\n",
+    "q = '''\n",
+    "    SELECT DISTINCT  \n",
+    "        \"POWERCO_FINANCIAL_YEAR\",\n",
+    "        \"ICPDAILYCOUNTAVERAGEYTD\" as \"ICP_DAILY_COUNT_AVERAGE_YTD\"\n",
+    "    FROM \"ZPUBLIC\".\"ZV_BW4_D_F_MDS_ICP_COUNT\"\n",
+    "    WHERE  (\"LATESTINFYDATEIND\" = '1' ) \n",
+    "'''\n",
+    "\n",
+    "hci.hana_sql(q,'pandas')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "c3632643",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Token expires at: 2026-02-02 15:00:38.586668\n"
+     ]
+    },
+    {
+     "data": {
+      "text/html": [
+       "<div><style>\n",
+       ".dataframe > thead > tr,\n",
+       ".dataframe > tbody > tr {\n",
+       "  text-align: right;\n",
+       "  white-space: pre-wrap;\n",
+       "}\n",
+       "</style>\n",
+       "<small>shape: (12, 2)</small><table border=\"1\" class=\"dataframe\"><thead><tr><th>POWERCO_FINANCIAL_YEAR</th><th>ICP_DAILY_COUNT_AVERAGE_YTD</th></tr><tr><td>str</td><td>i64</td></tr></thead><tbody><tr><td>&quot;2016-2017&quot;</td><td>333925</td></tr><tr><td>&quot;2023-2024&quot;</td><td>359939</td></tr><tr><td>&quot;2014-2015&quot;</td><td>326597</td></tr><tr><td>&quot;2021-2022&quot;</td><td>352685</td></tr><tr><td>&quot;2020-2021&quot;</td><td>347964</td></tr><tr><td>&hellip;</td><td>&hellip;</td></tr><tr><td>&quot;2025-2026&quot;</td><td>364634</td></tr><tr><td>&quot;2015-2016&quot;</td><td>330630</td></tr><tr><td>&quot;2022-2023&quot;</td><td>356743</td></tr><tr><td>&quot;2017-2018&quot;</td><td>336728</td></tr><tr><td>&quot;2019-2020&quot;</td><td>344040</td></tr></tbody></table></div>"
+      ],
+      "text/plain": [
+       "shape: (12, 2)\n",
+       "┌────────────────────────┬─────────────────────────────┐\n",
+       "│ POWERCO_FINANCIAL_YEAR ┆ ICP_DAILY_COUNT_AVERAGE_YTD │\n",
+       "│ ---                    ┆ ---                         │\n",
+       "│ str                    ┆ i64                         │\n",
+       "╞════════════════════════╪═════════════════════════════╡\n",
+       "│ 2016-2017              ┆ 333925                      │\n",
+       "│ 2023-2024              ┆ 359939                      │\n",
+       "│ 2014-2015              ┆ 326597                      │\n",
+       "│ 2021-2022              ┆ 352685                      │\n",
+       "│ 2020-2021              ┆ 347964                      │\n",
+       "│ …                      ┆ …                           │\n",
+       "│ 2025-2026              ┆ 364634                      │\n",
+       "│ 2015-2016              ┆ 330630                      │\n",
+       "│ 2022-2023              ┆ 356743                      │\n",
+       "│ 2017-2018              ┆ 336728                      │\n",
+       "│ 2019-2020              ┆ 344040                      │\n",
+       "└────────────────────────┴─────────────────────────────┘"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "hci = Hana_cloud_interface()\n",
+    "\n",
+    "q = '''\n",
+    "    SELECT DISTINCT  \n",
+    "        \"POWERCO_FINANCIAL_YEAR\",\n",
+    "        \"ICPDAILYCOUNTAVERAGEYTD\" as \"ICP_DAILY_COUNT_AVERAGE_YTD\"\n",
+    "    FROM \"ZPUBLIC\".\"ZV_BW4_D_F_MDS_ICP_COUNT\"\n",
+    "    WHERE  (\"LATESTINFYDATEIND\" = '1' ) \n",
+    "'''\n",
+    "\n",
+    "hci.hana_sql(q,'polars')"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "hana-cloud-interface (3.13.5)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

hana_cloud_interface-0.3.0.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.3
+Name: hana-cloud-interface
+Version: 0.3.0
+Summary: Runs a SQL command on SAP HANA Cloud using OAuth single sign on and returns a pandas or polars dataframe
+Author: charlotte corpe
+Author-email: charlotte corpe <charlotte.corpe@powerco.co.nz>
+Requires-Dist: hdbcli
+Requires-Dist: polars
+Requires-Dist: pandas
+Requires-Dist: hana-ml
+Requires-Dist: platformdirs
+Requires-Dist: selenium
+Requires-Dist: webdriver-manager
+Requires-Dist: ipykernel
+Requires-Dist: requests-oauthlib
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Usage of the `hana_cloud_interface` package 
+
+This package provides a simple interface to connect to SAP HANA Cloud databases and execute SQL queries. Below are some examples of how to use the package.
+
+
+## initialising class
+when initialising the class it has two optional args. 
+
+- config_file : Path to the configuration file (JSON format) containing OAuth credentials and other settings. the config file only needs to be added on the first time running the class on a computer. 
+
+- data_frame_type : Default data frame type for SQL query results. Options are 'pandas' or 'polars'. Default is 'pandas'.
+if the data type is not added here it will need to be added for every time you run hana_sql function
+
+```python
+Hana_cloud_interface(config_file = 'location of configuration file',  df = 'pandas')
+```
+
+## hana_sql() function
+Execute a SQL command on the HANA Cloud database and return the result as a DataFrame.
+
+Args:
+    sql_command (str, optional): The SQL command to execute. Defaults to 'validate', which only checks the connection.
+    DF_type_local_override (str, optional): DataFrame type for this query ('pandas' or 'polars'). Overrides the global setting if provided. 
+
+Returns:
+    str: If sql_command is 'validate', returns a validation message.
+    pandas.DataFrame or polars.DataFrame: The query result as a DataFrame, depending on the specified or default DataFrame type.
+
+Raises:
+    ValueError: If the DataFrame type is not specified or is invalid.
+
+## hana_upload() function
+Upload a DataFrame to the HANA Cloud database.
+
+Args:
+    data (pandas.DataFrame or polars.DataFrame): The data to upload. If a polars DataFrame is provided, it will be converted to pandas.
+    data_name (str): The name of the table to create or replace in HANA Cloud.
+    SCHEMA (str): The schema in which to create the table.
+
+Returns:
+    bool: True if the upload is successful.
+
+Raises:
+    Exception: If the upload fails due to connection or data issues.
+
+
+## configuration file
+the configuration file is a .json file
+```python
+{
+    "CLIENT_ID": "",
+    "CLIENT_SECRET": "",
+    "AUTH_URL": "",
+    "TOKEN_URL": "",
+    "protected_url": "",
+    "REDIRECT_URI": "",
+    "SCOPE": "",
+	"HC_prod_URL": ""
+}
+```
+
+## example
+the main function is very simple It takes a SQL command as a string and returns the data
+```python
+import hana_cloud_interface 
+
+# initialise class
+hci = Hana_cloud_interface(df='polars')
+
+sql_command = """
+SELECT top 10
+    "data1"
+    "data2"
+FROM "table1"
+"""
+    
+data = hci.hana_sql(sql_command)
+
+```

hana_cloud_interface-0.3.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+hana_cloud_interface/__init__.py,sha256=eb53b0e75f591672241b2e92afd37eb22cd7e83681dd006b95a6d834d508eb9a,38
+hana_cloud_interface/main.py,sha256=3585cf1c79abb9c7264402475d3bcad6f3e5696985126751d8c0644895ed96f7,13220
+hana_cloud_interface/py.typed,sha256=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855,0
+hana_cloud_interface/test_doc.ipynb,sha256=6cb75af297c2df27423734d4297a80586f0f940e2cdd30516a3de8c1df080b51,27979
+hana_cloud_interface-0.3.0.dist-info/WHEEL,sha256=b70116f4076fa664af162441d2ba3754dbb4ec63e09d563bdc1e9ab023cce400,78
+hana_cloud_interface-0.3.0.dist-info/entry_points.txt,sha256=917e7d5e3aebcdb046ecc05aa1867cf208548aa5d2277b5714f205596b96b4e9,88
+hana_cloud_interface-0.3.0.dist-info/METADATA,sha256=4c0cfeaf52b1bc3c9e42ae57078bafa33322bd5d598dbae47d89c826dba7ee49,3170
+hana_cloud_interface-0.3.0.dist-info/RECORD,,

hana_cloud_interface-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.8.3
+Root-Is-Purelib: true
+Tag: py3-none-any

hana_cloud_interface-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+Reliability_Application_Manager = hana_cloud_interface.main:validate
+