qe-api-client 2.7.0__tar.gz → 2.8.0__tar.gz

{qe_api_client-2.7.0 → qe_api_client-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qe-api-client
-Version: 2.7.0
+Version: 2.8.0
 Summary: Python client for the Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev
@@ -11,8 +11,10 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: websocket-client>=0.47.0
+Requires-Dist: websocket-client>=1.0.0
 Requires-Dist: pandas>=2.2.0
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: uuid>=1.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{qe_api_client-2.7.0 → qe_api_client-2.8.0}/qe_api_client/api_classes/engine_generic_object_api.py

@@ -208,3 +208,21 @@ class EngineGenericObjectApi:
             return response["result"]
         except KeyError:
             return response["error"]
+
+
+    def get_properties(self, handle: int):
+        """
+        Retrieves the properties of a specific generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+
+        Returns:
+            dict: The properties of the generic object (qLayout). In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetProperties", "params": {}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]["qProp"]
+        except KeyError:
+            return response["error"]

{qe_api_client-2.7.0 → qe_api_client-2.8.0}/qe_api_client/engine.py

@@ -135,9 +135,9 @@ class QixEngine:
         # Define of the single dimension properties
         nx_info = self.structs.nx_info(obj_type="dimension")
         if dim_color is None:
-            coloring = self.structs.coloring()
+            coloring = self.structs.dim_coloring()
         else:
-            coloring = self.structs.coloring(base_color={"color": dim_color, "index": dim_color_index})
+            coloring = self.structs.dim_coloring(base_color={"color": dim_color, "index": dim_color_index})
 
         nx_library_dimension_def = self.structs.nx_library_dimension_def(grouping="N", field_definitions=[dim_def],
                                                                          field_labels=[dim_title],
@@ -213,7 +213,8 @@ class QixEngine:
 
 
     def create_master_measure(self, app_handle: int, mes_title: str, mes_def: str, mes_label: str = "",
-                              mes_desc: str = "", mes_tags: list = None):
+                              mes_desc: str = "", mes_tags: list = None, mes_color: str = None,
+                              mes_color_index: int = -1, gradient: dict = None):
         """
         Creates a master measure.
 
@@ -224,6 +225,8 @@ class QixEngine:
             mes_label (str, optional): The label of the measure.
             mes_desc (str, optional): The description of the measure.
             mes_tags (list, optional): The tags of the measure.
+            mes_color (str, optional): The color of the measure.
+            mes_color_index (int, optional): The index of the color of the measure.
 
         Returns:
             dict: The handle and Id of the measure.
@@ -233,8 +236,17 @@ class QixEngine:
 
         # Define of the measure properties
         nx_info = self.structs.nx_info(obj_type="measure")
+
+        if mes_color is None:
+            coloring = self.structs.mes_coloring()
+        else:
+            coloring = self.structs.mes_coloring(base_color={"color": mes_color, "index": mes_color_index})
+
+        if gradient is not None:
+            coloring.update({"gradient": gradient})
+
         nx_library_measure_def = self.structs.nx_library_measure_def(label=mes_title, mes_def=mes_def,
-                                                                     label_expression=mes_label)
+                                                                     label_expression=mes_label, coloring=coloring)
         gen_mes_props = self.structs.generic_measure_properties(nx_info=nx_info,
                                                                 nx_library_measure_def=nx_library_measure_def,
                                                                 title=mes_title, description=mes_desc, tags=mes_tags)
@@ -526,14 +538,25 @@ class QixEngine:
         # Determine the number of the columns and the rows the table has and splits in certain circumstances the table
         # calls
         no_of_columns = obj_layout['qHyperCube']['qSize']['qcx']
+
+        if no_of_columns == 0:
+            return 'The chart either contains no columns or has a calculation condition!'
+
         width = no_of_columns
         no_of_rows = obj_layout['qHyperCube']['qSize']['qcy']
         height = int(math.floor(10000 / no_of_columns))
 
         # Extract the dimension and measure titles and concat them to column names.
-        dimension_titles = [dim['qFallbackTitle'] for dim in obj_layout['qHyperCube']['qDimensionInfo']]
-        measure_titles = [measure['qFallbackTitle'] for measure in obj_layout['qHyperCube']['qMeasureInfo']]
-        column_names = dimension_titles + measure_titles
+        dimension_info = obj_layout['qHyperCube'].get('qDimensionInfo', [])
+        measure_info = obj_layout['qHyperCube'].get('qMeasureInfo', [])
+        column_info = dimension_info + measure_info
+
+        # Build the column mapping using qEffectiveInterColumnSortOrder
+        sort_order = sorted(obj_layout['qHyperCube']['qEffectiveInterColumnSortOrder'])
+        sort_order_positive = [x for x in sort_order if x >= 0]
+        column_names = []
+        for i in sort_order_positive:
+            column_names.append(column_info[i]["qFallbackTitle"])
 
         # if the type of the charts has a straight data structure
         if (obj_layout['qInfo']['qType'] in ['table', 'sn-table', 'piechart', 'scatterplot', 'combochart', 'barchart']
@@ -563,9 +586,10 @@ class QixEngine:
 
             # Supporting function to traverse all subnodes to get all dimensions
             def get_all_dimensions(node):
-                dimensions = [node['qText']]
-                # if 'qSubNodes' in node and node['qSubNodes']:
-                if node['qSubNodes']:
+                label = node.get('qText', '')  # Leerer String, falls nicht vorhanden
+                dimensions = [label]
+
+                if 'qSubNodes' in node and node['qSubNodes']:
                     sub_dimensions = []
                     for sub_node in node['qSubNodes']:
                         sub_dimensions.extend([dimensions + d for d in get_all_dimensions(sub_node)])
@@ -573,13 +597,25 @@ class QixEngine:
                 else:
                     return [dimensions]
 
-            # Gets the column headers for the pivot table
+            # Supporting function to get all column headers for the pivot table
+            def get_column_paths(node):
+                label = node.get('qText', '')
+                current_path = [label]
+
+                if 'qSubNodes' in node and node['qSubNodes']:
+                    paths = []
+                    for sub in node['qSubNodes']:
+                        for path in get_column_paths(sub):
+                            paths.append(current_path + path)
+                    return paths
+                else:
+                    return [current_path]
+
             col_headers = []
             nx_page_top = self.structs.nx_page(left=0, top=0, width=width, height=1)
-            hc_top = self.egoa.get_hypercube_pivot_data(obj_handle, '/qHyperCubeDef', nx_page_top)[
-                'qDataPages'][0]['qTop']
+            hc_top = self.egoa.get_hypercube_pivot_data(obj_handle, '/qHyperCubeDef', nx_page_top)['qDataPages'][0]['qTop']
             for top_node in hc_top:
-                col_headers.extend(get_all_dimensions(top_node))
+                col_headers.extend(get_column_paths(top_node))
 
             # Paging variables
             page = 0
@@ -610,6 +646,9 @@ class QixEngine:
 
             # Creates the Dataframe
             df = pd.DataFrame(data_values, index=row_index, columns=col_index)
+            index_levels = df.index.nlevels
+            df.index.names = column_names[:index_levels]
+            df = df.reset_index()
 
         # if the type of the charts has a stacked data structure
         elif obj_layout['qInfo']['qType'] in ['barchart'] and obj_layout['qHyperCube']['qStackedDataPages'] != []:

{qe_api_client-2.7.0 → qe_api_client-2.8.0}/qe_api_client/structs.py

@@ -277,14 +277,18 @@ def nx_library_dimension_def(grouping: str = "N", field_definitions: list = None
 
 
 def nx_library_measure_def(label: str, mes_def: str, grouping: str = "N", expressions: list = None,
-                           active_expression: int = 0, label_expression:str = "", num_format: dict = None):
+                           active_expression: int = 0, label_expression:str = "", num_format: dict = None,
+                           coloring: dict = None):
+    if coloring is None:
+        coloring = {}
     if num_format is None:
         num_format = {}
     if expressions is None:
         expressions = []
     return {
         "qLabel": label, "qDef": mes_def,"qGrouping": grouping, "qExpressions": expressions,
-        "qActiveExpression": active_expression, "qLabelExpression": label_expression, "qNumFormat": num_format
+        "qActiveExpression": active_expression, "qLabelExpression": label_expression, "qNumFormat": num_format,
+        "coloring": coloring
     }
 
 
@@ -509,7 +513,7 @@ def color_map(colors: list = None, nul: dict = None, oth: dict = None, pal: str
     }
 
 
-def coloring(change_hash: str = None, color_map_ref: str = "", has_value_colors: bool = False, base_color: dict = None):
+def dim_coloring(change_hash: str = None, color_map_ref: str = "", has_value_colors: bool = False, base_color: dict = None):
     if base_color is None:
         base_color = {"color": "none", "index": 0}
     return {
@@ -520,6 +524,15 @@ def coloring(change_hash: str = None, color_map_ref: str = "", has_value_colors:
     }
 
 
+def mes_coloring(base_color: dict = None, _gradient: dict = None):
+    coloring = {}
+    if base_color is not None:
+        coloring.update({"baseColor": base_color})
+    if _gradient is not None:
+        coloring.update({"gradient": _gradient})
+    return coloring
+
+
 def color_map_properties(dim_id: str, prop_def:dict = None, extends_id: str = "", state_name: str = "",
                          _color_map: dict = None):
 
@@ -539,3 +552,17 @@ def value_color(value: str, color: str, index: int = -1):
         "value": value,
         "baseColor": {"color": color, "index": index}
     }
+
+
+def color(_color: str, index: int = -1):
+    return {"color": _color, "index": index}
+
+
+def gradient(colors: list = None, break_types: list = None, limits: list = None, limit_type: str = "percent"):
+    if colors is None:
+        colors = [color(_color="#332288"), color(_color="#117733")]
+    if break_types is None:
+        break_types = [False]
+    if limits is None:
+        limits = [0.5]
+    return {"colors": colors, "breakTypes": break_types, "limits": limits, "limitType": limit_type}

{qe_api_client-2.7.0 → qe_api_client-2.8.0}/qe_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qe-api-client
-Version: 2.7.0
+Version: 2.8.0
 Summary: Python client for the Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev
@@ -11,8 +11,10 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: websocket-client>=0.47.0
+Requires-Dist: websocket-client>=1.0.0
 Requires-Dist: pandas>=2.2.0
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: uuid>=1.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

qe_api_client-2.8.0/qe_api_client.egg-info/requires.txt

@@ -0,0 +1,4 @@
+websocket-client>=1.0.0
+pandas>=2.2.0
+numpy>=2.0.0
+uuid>=1.0

{qe_api_client-2.7.0 → qe_api_client-2.8.0}/setup.py

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

qe_api_client-2.8.0/test/test.py

@@ -0,0 +1,36 @@
+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
+# app_id = "0c6a91a3-4dc0-490e-ae0f-41391b39c2ec" # Bonus Competitions
+# app_id = "f9e79d92-652b-4ba8-8487-84e2825b71c5"     # Sales KPI
+# app_id = "3b9ef434-f4e9-4310-9cef-1347502bc39d"     # Stocks
+# app_id = "0a64346c-da25-4fd5-b1a7-e3d897d270e3"     # Sales & Stocks
+app_id = "Test.qvf"
+
+# App öffnen
+opened_app = qixe.ega.open_doc(app_id)
+
+app_handle = qixe.get_handle(opened_app)
+
+# qixe.select_in_field(app_handle=app_handle, field_name="TopicBox_ABC_Analysis", list_of_values=["ABC Analysis", "Detailed stock information", "Avg. sales per week + range of coverage", "Sales per month", "Sales per week"])
+
+df = qixe.get_chart_data(app_handle=app_handle, obj_id="xPpxvy")
+print(df.to_string())
+df.to_csv('C:/Users/R.Vasilev/OneDrive - LR/Desktop/out.csv', index=False)
+
+# Websocket-Verbindung schließen
+QixEngine.disconnect(qixe)

qe_api_client-2.7.0/qe_api_client.egg-info/requires.txt

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

qe_api_client-2.7.0/test/test.py

@@ -1,43 +0,0 @@
-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)