hana-cloud-interface 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

hana_cloud_interface/__init__.py

@@ -1 +1 @@
-from .main import hana_sql, config_file, data_frame_type, Browser_override
+from .main import hana_sql, initialize_settings

hana_cloud_interface/main.py

@@ -13,11 +13,29 @@ import polars as pl
 import pandas as pd
 import os
 
-config_file = r'C:\python\Hana_Cloud_interface\hc_oauth_config.json'
-Browser_override = r'C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe'
-data_frame_type = 'pandas' # Default data frame type for hana_sql function
+config_file_g = ''
+Browser_override_g = ''
+data_frame_type_g = 'pandas' # Default data frame type for hana_sql function
 debug = False
 
+def initialize_settings(config_file = '', Browser_override = '', data_frame_type = 'pandas'):
+    """
+    Initializes global settings for the Hana Cloud interface.
+
+    Parameters:
+    config_file (str): Path to the configuration file.
+    Browser_override (str): Optional browser override for OAuth authentication.
+    data_frame_type (str): Default data frame type for SQL query results ('pandas' or 'polars').
+
+    Sets global variables for configuration file path, browser override, and data frame type.
+    """
+    global config_file_g, Browser_override_g, data_frame_type_g
+    config_file_g = config_file
+    Browser_override_g = Browser_override
+    data_frame_type_g = data_frame_type
+    
+    
+    
 def test_connection(oauth_config):
     oauth_Token = keyring.get_password('SAP_hana_sso', 'oauth_Token')
     
@@ -159,8 +177,8 @@ def get_token(i=0):
         authorization_url = f"{oauth_config['AUTH_URL']}?{urllib.parse.urlencode(params)}"
 
         # Open web browser and go to oauth url
-        if Browser_override != '':
-            webbrowser.get(Browser_override).open(authorization_url,new=1)
+        if Browser_overrid_ge != '':
+            webbrowser.get(Browser_override_g).open(authorization_url,new=1)
         else:
             webbrowser.open(authorization_url,new=1)
             
@@ -188,9 +206,9 @@ def config_reader():
     # reads config data from keychain
     config_data = keyring.get_password('SAP_hana_sso', 'config_data')
     if not config_data: # If there is no existing config data saved to the credentials manager read from file and save it
-        if not os.path.exists(config_file):
-            raise FileNotFoundError(f"Config file not found: {config_file}")
-        with open(config_file) as file:
+        if not os.path.exists(config_file_g):
+            raise FileNotFoundError(f"Config file not found: {config_file_g}")
+        with open(config_file_g) as file:
             config_data = json.load(file)
         keyring.set_password('SAP_hana_sso', 'config_data', json.dumps(config_data))
         return config_data
@@ -200,7 +218,7 @@ def config_reader():
 
 
 
-def hana_sql(sql_command='test',DF_type = data_frame_type):
+def hana_sql(sql_command='test',DF_type = data_frame_type_g):
     """ handles single sign on then runs a SQL command
 
     Parameters:

hana_cloud_interface-0.1.6.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.3
+Name: hana-cloud-interface
+Version: 0.1.6
+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: keyring
+Requires-Dist: hdbcli
+Requires-Dist: polars
+Requires-Dist: pandas
+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.
+
+
+## example
+the main function is very simple It takes a SQL command as a string and returns the data
+```python
+import hana_cloud_interface as hci
+
+sql_command = """
+SELECT top 10
+    "data1"
+    "data2"
+FROM "table1"
+"""
+    
+data = hci.hana_sql(sql_command)
+
+```
+
+## initialising settings
+Before using the package, you need to initialize the settings by specifying the configuration file location, browser override (if needed), and the default data frame type for SQL query results.
+
+config_file : Path to the configuration file (JSON format) containing OAuth credentials and other settings.
+
+Browser_override : Optional parameter to specify a browser for OAuth authentication. If left empty, the default browser will be used. this needs to be the path to the executable for the browser
+
+data_frame_type : Default data frame type for SQL query results. Options are 'pandas' or 'polars'. Default is 'pandas'.
+
+```python
+hci.initialize_settings(config_file = 'location of configuration file', Browser_override = '', data_frame_type = 'pandas')
+```
+the configuration file is a .json file
+```python
+{
+    "CLIENT_ID": "",
+    "CLIENT_SECRET": "",
+    "AUTH_URL": "",
+    "TOKEN_URL": "",
+    "protected_url": "",
+    "REDIRECT_URI": "",
+    "SCOPE": "",
+	"HC_prod_URL": ""
+}
+```

hana_cloud_interface-0.1.6.dist-info/RECORD

@@ -0,0 +1,6 @@
+hana_cloud_interface/__init__.py,sha256=906f9595b4c5204bd8fa8ee1339d5a60da87904eb00bafaec724ab8c9f0e7305,47
+hana_cloud_interface/main.py,sha256=9ce84770db8c48a87095ac803c2d4a6844c29dbf3917c9b10f2f1bcaacf46857,9650
+hana_cloud_interface/py.typed,sha256=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855,0
+hana_cloud_interface-0.1.6.dist-info/WHEEL,sha256=b70116f4076fa664af162441d2ba3754dbb4ec63e09d563bdc1e9ab023cce400,78
+hana_cloud_interface-0.1.6.dist-info/METADATA,sha256=0937d4566f52bd35053a0eb598cb7d9304510ad1932f8bb6c4462ba59c58a270,1943
+hana_cloud_interface-0.1.6.dist-info/RECORD,,

hana_cloud_interface-0.1.4.dist-info/METADATA

@@ -1,13 +0,0 @@
-Metadata-Version: 2.3
-Name: hana-cloud-interface
-Version: 0.1.4
-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: keyring
-Requires-Dist: hdbcli
-Requires-Dist: polars
-Requires-Dist: pandas
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-

hana_cloud_interface-0.1.4.dist-info/RECORD

@@ -1,6 +0,0 @@
-hana_cloud_interface/__init__.py,sha256=afee63541644ae210da90e08e3cee1af035edaa6905ff49ee2ac2aca921e6897,74
-hana_cloud_interface/main.py,sha256=123fc760b710e70e85564de442f06a7810ab311a85f6995864d083976e06538a,9036
-hana_cloud_interface/py.typed,sha256=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855,0
-hana_cloud_interface-0.1.4.dist-info/WHEEL,sha256=b70116f4076fa664af162441d2ba3754dbb4ec63e09d563bdc1e9ab023cce400,78
-hana_cloud_interface-0.1.4.dist-info/METADATA,sha256=1f4beef9c115ff3f16be964202a5ddab8fd558c4f5bd081000870049fdab5822,418
-hana_cloud_interface-0.1.4.dist-info/RECORD,,