qe-api-client 2.3.0__tar.gz → 2.4.0__tar.gz

{qe_api_client-2.3.0 → qe_api_client-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: qe-api-client
-Version: 2.3.0
+Version: 2.4.0
 Summary: Python wrapper around Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev
@@ -12,6 +12,16 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: websocket-client>=0.47.0
+Requires-Dist: pandas>=2.2.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Qlik Engine API Client
 

{qe_api_client-2.3.0 → qe_api_client-2.4.0}/qe_api_client/api_classes/engine_app_api.py

@@ -708,5 +708,24 @@ class EngineAppApi:
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']
+        except KeyError:
+            return response['error']
+
+    def get_variable_by_id(self, doc_handle, variable_id):
+        """
+        Gets the handle of a variable.
+
+        Parameters:
+            doc_handle (int): The handle identifying the document.
+            variable_id (str): The id of the variable.
+
+        Returns:
+            dict: The handle of the generic variable.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetVariableById",
+                          "params": {"qId": variable_id}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response['result']['qReturn']
         except KeyError:
             return response['error']

{qe_api_client-2.3.0 → qe_api_client-2.4.0}/qe_api_client/engine_communicator.py

@@ -22,21 +22,12 @@ class EngineCommunicator:
 
 class SecureEngineCommunicator(EngineCommunicator):
 
-    def __init__(self, url, user_directory,
-                 user_id, ca_certs, certfile,
-                 keyfile, app_id=None
-                 ):
+    def __init__(self, url, user_directory, user_id, ca_certs, certfile, keyfile, app_id=None):
         self.url = "wss://" + url + ":4747/app/" + str(app_id)
-        certs = ({"ca_certs": ca_certs,
-                  "certfile": certfile,
-                  "keyfile": keyfile,
-                  "cert_reqs": ssl.CERT_NONE,
-                  "server_side": False
-                  })
+        certs = ({"ca_certs": ca_certs, "certfile": certfile, "keyfile": keyfile, "cert_reqs": ssl.CERT_NONE,
+                  "server_side": False})
 
         ssl.match_hostname = lambda cert, hostname: True
         header = f'X-Qlik-User: UserDirectory={user_directory}; UserId={user_id}'  # NOQA
-        self.ws = create_connection(
-                self.url, sslopt=certs,
-                cookie=None, header={header})
+        self.ws = create_connection(self.url, sslopt=certs, cookie=None, header={header})
         self.session = self.ws.recv()

{qe_api_client-2.3.0 → qe_api_client-2.4.0}/qe_api_client/structs.py

@@ -70,4 +70,9 @@ def generic_measure_properties(info, lb_meas_def, meas_title):
 
 def do_reload_ex_params(mode=0, partial=False, debug=False, reload_id="", skip_store=False, row_limit=0):
     return {"qMode": mode, "qPartial": partial, "qDebug": debug, "qReloadId": reload_id, "qSkipStore": skip_store,
-            "qRowLimit": row_limit}
+            "qRowLimit": row_limit}
+
+def dimension_list_def():
+    return {"qInfo": {"qType": "DimensionList"},
+            "qDimensionListDef": {"qType": "dimension",
+            "qData": {"title": "/title", "tags": "/tags", "grouping": "/qDim/qGrouping", "info": "/qDimInfos"}}}

{qe_api_client-2.3.0 → qe_api_client-2.4.0}/qe_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: qe-api-client
-Version: 2.3.0
+Version: 2.4.0
 Summary: Python wrapper around Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev
@@ -12,6 +12,16 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: websocket-client>=0.47.0
+Requires-Dist: pandas>=2.2.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Qlik Engine API Client
 

{qe_api_client-2.3.0 → qe_api_client-2.4.0}/qe_api_client.egg-info/SOURCES.txt

@@ -18,7 +18,10 @@ qe_api_client/api_classes/engine_generic_measure_api.py
 qe_api_client/api_classes/engine_generic_object_api.py
 qe_api_client/api_classes/engine_generic_variable_api.py
 qe_api_client/api_classes/engine_global_api.py
+test/test.py
+test/test_api.py
 test/test_app_api.py
+test/test_chart_content.py
 test/test_field_api.py
 test/test_global_api.py
 test/test_labs.py

{qe_api_client-2.3.0 → qe_api_client-2.4.0}/qe_api_client.egg-info/requires.txt

@@ -1 +1,2 @@
 websocket-client>=0.47.0
+pandas>=2.2.0

{qe_api_client-2.3.0 → qe_api_client-2.4.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="qe-api-client",
-    version="2.3.0",
+    version="2.4.0",
     author="Rumen Vasilev",
     author_email="R.Vasilev@LRWorld.com",
     description="Python wrapper around Qlik Engine JSON API",
@@ -20,7 +20,8 @@ setuptools.setup(
         "Operating System :: OS Independent",
     ],
     install_requires=[
-        'websocket-client>=0.47.0'
+        'websocket-client>=0.47.0',
+        'pandas>=2.2.0'
     ],
     python_requires='>=3.6',
 )

qe_api_client-2.4.0/test/test.py

@@ -0,0 +1,43 @@
+from qe_api_client.engine import QixEngine
+import math
+import pandas as pd
+
+# url = 'ws://localhost:4848/app'
+# qixe = QixEngine(url=url)
+
+url = "lr-analytics-test.lr-netz.local"
+user_directory = "LR"
+user_id = "!QlikSense"
+qlik_certs_path = "C:/LocalUserData/Certificates/Sense TEST"
+ca_certs = qlik_certs_path + "/root.pem"
+certfile = qlik_certs_path + "/client.pem"
+keyfile = qlik_certs_path + "/client_key.pem"
+qixe = QixEngine(url, user_directory, user_id, ca_certs, certfile, keyfile)
+
+# App ID holen
+doc_id = "0c6a91a3-4dc0-490e-ae0f-41391b39c2ec" # Bonus Competitions
+# doc_id = "f9e79d92-652b-4ba8-8487-84e2825b71c5"     # Sales KPI
+# doc_id = "Test.qvf"
+
+# App öffnen
+opened_doc = qixe.ega.open_doc(doc_id)
+print(opened_doc)
+
+doc_handle = qixe.get_handle(opened_doc)
+
+# # Lineage-Daten aus der API holen
+# lineage = qixe.eaa.get_lineage(doc_handle)
+# print(lineage)
+#
+# # Erstelle den DataFrame und fülle fehlende Werte mit ""
+# df = pd.DataFrame(lineage)  #.fillna("")
+# df = df[(df["qDiscriminator"].notna()) | (df["qStatement"].notna())].fillna("")
+# # df = df.reindex(columns=["qDiscriminator", "qStatement"]).fillna("")
+
+df = qixe.get_app_lineage_info(doc_handle)
+
+print(df)
+
+
+# Websocket-Verbindung schließen
+QixEngine.disconnect(qixe)

qe_api_client-2.4.0/test/test_api.py

@@ -0,0 +1,52 @@
+from qe_api_client.engine import QixEngine
+from qe_api_client.structs import field_value
+
+# url = 'lr-analytics-test.lr-netz.local'
+# user_directory = 'LR'
+# user_id = 'r.vasilev'
+# ca_certs = 'C:\\LocalUserData\\Certificates\\Sense TEST\\root.pem'
+# certfile = 'C:\\LocalUserData\\Certificates\\Sense TEST\\client.pem'
+# keyfile = 'C:\\LocalUserData\\Certificates\\Sense TEST\\client_key.pem'
+# qixe = QixEngine(url=url, user_directory=user_directory, user_id=user_id, ca_certs=ca_certs, certfile=certfile,
+#                  keyfile=keyfile)
+
+url = 'ws://localhost:4848/app'
+qixe = QixEngine(url)
+opened_app = qixe.ega.open_doc("Test")
+# print(opened_app)
+app_handle = qixe.get_handle(opened_app)
+# print(app_handle)
+
+list_of_values = ["A", "C"]
+
+test = qixe.select_in_dimension(app_handle, "Dim1", ["A", "B"])
+print(test)
+
+# field = qixe.eaa.get_field(app_handle, "Dim1")
+# print(field)
+#
+# fld_handle = qixe.get_handle(field)
+# print(fld_handle)
+
+# selected_value = qixe.efa.select(field_handle, "B")
+# print(selected_value)
+
+# fld_value_1 = qixe.structs.field_value("A")
+# fld_value_2 = qixe.structs.field_value("C")
+# selected_values = qixe.efa.select_values(fld_handle, [fld_value_1, fld_value_2])
+
+# values_to_select = []
+# for val in list_of_values:
+#     fld_value = qixe.structs.field_value(val)
+#     values_to_select.append(fld_value)
+# response = qixe.efa.select_values(fld_handle, values_to_select)
+# print(response)
+
+df = qixe.get_constructed_table_data(app_handle, [], [],
+                                     ["BjKvssq", "48a5672b-e9b3-4f96-8ff4-480f606e3c14"],
+                                     ["snmpR", "1ad7060c-56ec-46d1-b83a-ff1393e0b236"])
+
+print(df)
+
+# Websocket-Verbindung schließen
+QixEngine.disconnect(qixe)

qe_api_client-2.4.0/test/test_chart_content.py

@@ -0,0 +1,17 @@
+from qe_api_client.engine import QixEngine
+
+url = 'ws://localhost:4848/app'
+qixe = QixEngine(url=url)
+
+# App ID holen
+# doc_id = "f9e79d92-652b-4ba8-8487-84e2825b71c5"     # Sales KPI
+doc_id = "Test.qvf"
+
+# App öffnen
+opened_doc = qixe.ega.open_doc(doc_id)
+# print(opened_doc)
+
+doc_handle = qixe.get_handle(opened_doc)
+
+df = qixe.get_chart_data(doc_handle, "tshujdG")   # Pivot: wPSYmr | Straight: tshujdG | Bar chart: LapHp | Pie chart: gYyUxS
+print(df)