qe-api-client 1.1.0__tar.gz → 2.0.0__tar.gz

{qe_api_client-1.1.0 → qe_api_client-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qe-api-client
-Version: 1.1.0
+Version: 2.0.0
 Summary: Python wrapper around Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev
@@ -13,7 +13,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: websocket-client>=0.47.0
 
-# pyqlikengine
+# Qlik Engine API Client
 
 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)
 
@@ -23,10 +23,15 @@ Forked from [jhettler/pyqlikengine](https://github.com/jhettler/pyqlikengine)
 * Python 3.6+
 * websocket-client>=0.47.0
 
-## Example of usage
+## Installation
 ```bash
 pip install qe-api-client
 ```
+
+## Example of usage on Qlik Sense Enterprise Server
+You need to export the Qlik Sense certificates in PEM format from the Qlik Sense Enterprise server to a local folder in 
+order to authenticate on the server.
+
 ```python
 from qe_api_client.engine import QixEngine
 
@@ -36,10 +41,25 @@ 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)
+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())
+```
+
+## Example of usage on Qlik Sense Desktop
+You need to start your Qlik Sense Desktop client on your local PC.
+
+```python
+from qe_api_client.engine import QixEngine
+
+url = 'ws://localhost:4848/app'
+qixe = QixEngine(url=url)
 
 # print all apps in Qlik Server
 print(qixe.ega.get_doc_list())
 ```
+
+## API reference
+Please click on this [link](https://lr-bicc.github.io/qe-api-client) for full API reference documentation .

qe_api_client-2.0.0/README.md

@@ -0,0 +1,50 @@
+# Qlik Engine API Client
+
+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
+
+## Installation
+```bash
+pip install qe-api-client
+```
+
+## Example of usage on Qlik Sense Enterprise Server
+You need to export the Qlik Sense certificates in PEM format from the Qlik Sense Enterprise server to a local folder in 
+order to authenticate on the server.
+
+```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())
+```
+
+## Example of usage on Qlik Sense Desktop
+You need to start your Qlik Sense Desktop client on your local PC.
+
+```python
+from qe_api_client.engine import QixEngine
+
+url = 'ws://localhost:4848/app'
+qixe = QixEngine(url=url)
+
+# print all apps in Qlik Server
+print(qixe.ega.get_doc_list())
+```
+
+## API reference
+Please click on this [link](https://lr-bicc.github.io/qe-api-client) for full API reference documentation .