qe-api-client 1.0.0__py3-none-any.whl

qe_api_client/structs.py

@@ -0,0 +1,107 @@
+class Structs:
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def list_object_def(state_name="$", library_id="",
+                        field_defs=None, field_labels=None,
+                        sort_criterias=None, initial_data_fetch=None
+                        ):
+        if initial_data_fetch is None:
+            initial_data_fetch = []
+        if sort_criterias is None:
+            sort_criterias = []
+        if field_labels is None:
+            field_labels = []
+        if field_defs is None:
+            field_defs = []
+        return {"qStateName": state_name,
+                "qLibraryId": library_id,
+                "qDef": {
+                    "qFieldDefs": field_defs,
+                    "qFieldLabels": field_labels,
+                    "qSortCriterias": sort_criterias
+                },
+                "qInitialDataFetch": initial_data_fetch
+                }
+
+    @staticmethod
+    def hypercube_def(state_name="$", nx_dims=[],
+                      nx_meas=[], nx_page=[],
+                      inter_column_sort=[0, 1, 2], suppress_zero=False,
+                      suppress_missing=False
+                      ):
+        return {"qStateName": state_name,
+                "qDimensions": nx_dims,  # NxDimensions
+                "qMeasures": nx_meas,  # NxMeasure
+                "qInterColumnSortOrder": inter_column_sort,
+                "qSuppressZero": suppress_zero,
+                "qSuppressMissing": suppress_missing,
+                "qInitialDataFetch": nx_page,  # NxPage
+                "qMode": 'S',
+                "qNoOfLeftDims": -1,
+                "qAlwaysFullyExpanded": False,
+                "qMaxStackedCells": 5000,
+                "qPopulateMissing": False,
+                "qShowTotalsAbove": False,
+                "qIndentMode": False,
+                "qCalcCond": "",
+                "qSortbyYValue": 0
+                }
+
+    @staticmethod
+    def nx_hypercube_dimensions(dim_def):
+        return {"qLibraryId": "",
+                "qNullSuppression": False,
+                "qDef": dim_def
+                }
+
+    @staticmethod
+    def nx_inline_dimension_def(field_definitions=[],
+                                grouping='N',
+                                field_labels=[]
+                                ):
+        return {"qGrouping": grouping,
+                "qFieldDefs": field_definitions,
+                "qFieldLabels": field_labels
+                }
+
+    @staticmethod
+    def nx_hypercube_measure(sort_by={}, nx_inline_measures_def=""):
+        return {"qSortBy": sort_by,
+                "qDef": nx_inline_measures_def
+                }
+
+    @staticmethod
+    def nx_sort_by(state=0, freq=0, numeric=0, ascii=0, load_order=1):
+        return {"qSortByState": state,
+                "qSortByFrequency": freq,
+                "qSortByNumeric": numeric,
+                "qSortByAscii": ascii,
+                "qSortByLoadOrder": load_order,
+                "qSortByExpression": 0,
+                "qExpression": {
+                    "qv": ""
+                    }
+                }
+
+    @staticmethod
+    def nx_inline_measure_def(definition, label="",
+                              description="",
+                              tags=[],
+                              grouping="N"
+                              ):
+        return {"qLabel": label,
+                "qDescription":	description,
+                "qTags": tags,
+                "qGrouping": grouping,
+                "qDef":	definition
+                }
+
+    @staticmethod
+    def nx_page(top=0, left=0, height=2, width=2):
+        return {"qTop": top,
+                "qLeft": left,
+                "qHeight": height,
+                "qWidth": width
+                }

qe_api_client-1.0.0.dist-info/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qe_api_client-1.0.0.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: qe-api-client
+Version: 1.0.0
+Summary: Python wrapper around Qlik Engine JSON API
+Home-page: https://github.com/lr-bicc/qe-api-client
+Author: Rumen Vasilev
+Author-email: R.Vasilev@LRWorld.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: websocket-client >=0.47.0
+
+# pyqlikengine
+
+Python wrapper around [Qlik Engine JSON API](https://help.qlik.com/en-US/sense-developer/February2024/Subsystems/EngineAPI/Content/Sense_EngineAPI/introducing-engine-API.htm)
+
+Forked from [jhettler/pyqlikengine](https://github.com/jhettler/pyqlikengine)
+
+## Requirements
+* Python 3.6+
+* websocket-client>=0.47.0
+
+## Example of usage
+```bash
+pip install qe-api-client
+```
+```python
+from qe_api_client.engine import QixEngine
+
+url = 'qlik-1.ad.xxx.xxx'
+user_directory = 'UserDomainToQlikLogin'
+user_id = 'sense'
+ca_certs = 'qlik_certs/qlik-1_root.pem'
+certfile = 'qlik_certs/qlik-1_client.pem'
+keyfile = 'qlik_certs/qlik-1_client_key.pem'
+qixe = QixEngine(url=url, user_directory=user_directory,
+                 user_id=user_id, ca_certs=ca_certs,
+                 certfile=certfile, keyfile=keyfile)
+
+# print all apps in Qlik Server
+print(qixe.ega.get_doc_list())
+```

qe_api_client-1.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+qe_api_client/__init__.py,sha256=bypB4CIjpHtf5Pu_NwtJajC69zqQD7qB9jo8cCX0B54,23
+qe_api_client/engine.py,sha256=OKYxlPh4ley5g4ATfOqLxycg-ysAGiT5F1A0Ub8JAK4,6797
+qe_api_client/engine_app_api.py,sha256=_BE39CeNhe9j5wChMdObgz7-3WSKSYF9yx-nixpfzkw,40267
+qe_api_client/engine_communicator.py,sha256=Va8Kz4cN6uyKLzV3JllBw08KbU4uDn8e-5pIm5Kmsfs,1291
+qe_api_client/engine_field_api.py,sha256=L9a6sqQNmtoi8fnZfLBewbflbGg5RRA1CfCXkejnuNw,3166
+qe_api_client/engine_generic_object_api.py,sha256=s0yIqDhaWkRzNYQDDTYQKJkuEevl9xVaPnBT7uxBinc,4128
+qe_api_client/engine_global_api.py,sha256=CTHsmA-QG6Hoq_XOEJGQTg0ddslkG9s1f0Zzc8a9e54,20831
+qe_api_client/engine_helper.py,sha256=gxaTFU06YMGwXloxv3Sku6PbhDmTw_jEZdX9w-gfw5c,2337
+qe_api_client/structs.py,sha256=YHxIurQjmWWEZ-F3kZ_kQHkoWiVAqCpZB7k6hlioOxU,3709
+qe_api_client-1.0.0.dist-info/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
+qe_api_client-1.0.0.dist-info/METADATA,sha256=GoPkVED7pdyfB9gvlg2qfwPSTyCMPffoh8zAJIpzXrY,1376
+qe_api_client-1.0.0.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
+qe_api_client-1.0.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
+qe_api_client-1.0.0.dist-info/RECORD,,

qe_api_client-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (70.1.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

qe_api_client-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+qe_api_client