SK-1749: Updated README

skyflowapi · Nov 19, 2024 · 2e1272e · 2e1272e
1 parent e842282
commit 2e1272e
Show file tree

Hide file tree

Showing 11 changed files with 761 additions and 685 deletions.
diff --git a/README.md b/README.md
diff --git a/samples/vault_api/credentials_options.py b/samples/vault_api/credentials_options.py
@@ -6,9 +6,9 @@
 
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: "CREDENTIAL_STRING", // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: "CREDENTIAL_STRING", # credentials as string
 }
 
 skyflow_client = (

diff --git a/samples/vault_api/delete_records.py b/samples/vault_api/delete_records.py
@@ -10,9 +10,9 @@
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: "CREDENTIAL_STRING", // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: "CREDENTIAL_STRING", # credentials as string
 }
 
 client = (

diff --git a/samples/vault_api/get_column_values.py b/samples/vault_api/get_column_values.py
@@ -1,17 +1,16 @@
 from skyflow import Env
 from skyflow import Skyflow, LogLevel
 from skyflow.vault.data import GetRequest
-from skyflow.vault.tokens import DetokenizeRequest
 
 # To generate Bearer Token from credentials string.
 skyflow_credentials_string = '{"clientID":"<YOUR_CLIENT_ID>","clientName":"<YOUR_CLIENT_NAME>","tokenURI":"<YOUR_TOKEN_URI>","keyID":"<YOUR_KEY_ID>","privateKey":"<YOUR_PRIVATE_KEY>"}'
 
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: skyflow_credentials_string, // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: skyflow_credentials_string, # credentials as string
 }
 
 client = (

diff --git a/samples/vault_api/get_records.py b/samples/vault_api/get_records.py
@@ -1,17 +1,16 @@
 from skyflow import Env
 from skyflow import Skyflow, LogLevel
 from skyflow.vault.data import GetRequest
-from skyflow.vault.tokens import DetokenizeRequest
 
 # To generate Bearer Token from credentials string.
 skyflow_credentials_string = '{"clientID":"<YOUR_CLIENT_ID>","clientName":"<YOUR_CLIENT_NAME>","tokenURI":"<YOUR_TOKEN_URI>","keyID":"<YOUR_KEY_ID>","privateKey":"<YOUR_PRIVATE_KEY>"}'
 
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: skyflow_credentials_string, // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: skyflow_credentials_string, # credentials as string
 }
 
 client = (

diff --git a/samples/vault_api/insert_byot.py b/samples/vault_api/insert_byot.py
@@ -2,18 +2,17 @@
 from skyflow import Skyflow, LogLevel
 from skyflow.error import SkyflowError
 from skyflow.utils.enums import TokenStrict
-from skyflow.vault.data import GetRequest, InsertRequest
-from skyflow.vault.tokens import DetokenizeRequest
+from skyflow.vault.data import InsertRequest
 
 # To generate Bearer Token from credentials string.
 skyflow_credentials_string = '{"clientID":"<YOUR_CLIENT_ID>","clientName":"<YOUR_CLIENT_NAME>","tokenURI":"<YOUR_TOKEN_URI>","keyID":"<YOUR_KEY_ID>","privateKey":"<YOUR_PRIVATE_KEY>"}'
 
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: skyflow_credentials_string, // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: skyflow_credentials_string, # credentials as string
 }
 
 skyflow_client = (

diff --git a/samples/vault_api/insert_records.py b/samples/vault_api/insert_records.py
@@ -1,17 +1,16 @@
 from skyflow import Env
 from skyflow import Skyflow, LogLevel
-from skyflow.vault.data import GetRequest, InsertRequest
-from skyflow.vault.tokens import DetokenizeRequest
+from skyflow.vault.data import InsertRequest
 
 # To generate Bearer Token from credentials string.
 skyflow_credentials_string = '{"clientID":"<YOUR_CLIENT_ID>","clientName":"<YOUR_CLIENT_NAME>","tokenURI":"<YOUR_TOKEN_URI>","keyID":"<YOUR_KEY_ID>","privateKey":"<YOUR_PRIVATE_KEY>"}'
 
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: skyflow_credentials_string, // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: skyflow_credentials_string, # credentials as string
 }
 
 skyflow_client = (

diff --git a/samples/vault_api/invoke_connection.py b/samples/vault_api/invoke_connection.py
@@ -2,18 +2,16 @@
 from skyflow import Skyflow, LogLevel
 from skyflow.utils.enums import Method
 from skyflow.vault.connection import InvokeConnectionRequest
-from skyflow.vault.data import GetRequest, InsertRequest
-from skyflow.vault.tokens import DetokenizeRequest
 
 # To generate Bearer Token from credentials string.
 skyflow_credentials_string = '{"clientID":"<YOUR_CLIENT_ID>","clientName":"<YOUR_CLIENT_NAME>","tokenURI":"<YOUR_TOKEN_URI>","keyID":"<YOUR_KEY_ID>","privateKey":"<YOUR_PRIVATE_KEY>"}'
 
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: skyflow_credentials_string, // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: skyflow_credentials_string, # credentials as string
 }
 
 skyflow_client = (

diff --git a/samples/vault_api/query_records.py b/samples/vault_api/query_records.py
@@ -1,19 +1,16 @@
 from skyflow import Env
 from skyflow import Skyflow, LogLevel
-from skyflow.utils.enums import Method
-from skyflow.vault.connection import InvokeConnectionRequest
-from skyflow.vault.data import GetRequest, InsertRequest, QueryRequest
-from skyflow.vault.tokens import DetokenizeRequest
+from skyflow.vault.data import QueryRequest
 
 # To generate Bearer Token from credentials string.
 skyflow_credentials_string = '{"clientID":"<YOUR_CLIENT_ID>","clientName":"<YOUR_CLIENT_NAME>","tokenURI":"<YOUR_TOKEN_URI>","keyID":"<YOUR_KEY_ID>","privateKey":"<YOUR_PRIVATE_KEY>"}'
 
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: skyflow_credentials_string, // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: skyflow_credentials_string, # credentials as string
 }
 
 skyflow_client = (

diff --git a/samples/vault_api/tokenize_records.py b/samples/vault_api/tokenize_records.py
@@ -1,19 +1,16 @@
 from skyflow import Env
 from skyflow import Skyflow, LogLevel
-from skyflow.utils.enums import Method
-from skyflow.vault.connection import InvokeConnectionRequest
-from skyflow.vault.data import GetRequest, InsertRequest, QueryRequest
-from skyflow.vault.tokens import DetokenizeRequest, TokenizeRequest
+from skyflow.vault.tokens import TokenizeRequest
 
 # To generate Bearer Token from credentials string.
 skyflow_credentials_string = '{"clientID":"<YOUR_CLIENT_ID>","clientName":"<YOUR_CLIENT_NAME>","tokenURI":"<YOUR_TOKEN_URI>","keyID":"<YOUR_KEY_ID>","privateKey":"<YOUR_PRIVATE_KEY>"}'
 
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: skyflow_credentials_string, // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: skyflow_credentials_string, # credentials as string
 }
 
 skyflow_client = (

diff --git a/samples/vault_api/update_record.py b/samples/vault_api/update_record.py
@@ -1,19 +1,16 @@
 from skyflow import Env
 from skyflow import Skyflow, LogLevel
-from skyflow.utils.enums import Method
-from skyflow.vault.connection import InvokeConnectionRequest
-from skyflow.vault.data import GetRequest, InsertRequest, QueryRequest, UpdateRequest
-from skyflow.vault.tokens import DetokenizeRequest, TokenizeRequest
+from skyflow.vault.data import UpdateRequest
 
 # To generate Bearer Token from credentials string.
 skyflow_credentials_string = '{"clientID":"<YOUR_CLIENT_ID>","clientName":"<YOUR_CLIENT_NAME>","tokenURI":"<YOUR_TOKEN_URI>","keyID":"<YOUR_KEY_ID>","privateKey":"<YOUR_PRIVATE_KEY>"}'
 
 # please pass one of api_key, token, credentials_string & path as credentials
 credentials = {
         "token": "BEARER_TOKEN", # bearer token
-        # api_key: "API_KEY", //API_KEY
-        # path: "PATH", //path to credentials file
-        # credentials_string: skyflow_credentials_string, // credentials as string
+        # api_key: "API_KEY", # API_KEY
+        # path: "PATH", # path to credentials file
+        # credentials_string: skyflow_credentials_string, # credentials as string
 }
 
 skyflow_client = (