Skip to main content

Qlik Engine API Client

Python client for the Qlik Engine JSON API

Forked from jhettler/pyqlikengine

Requirements

  • Python 3.6+
  • websocket-client>=0.47.0

Installation

pip install qe-api-client

Connecting to 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.

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())

Connecting to Qlik Sense Desktop

You need to start your Qlik Sense Desktop client on your local PC.

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())

Examples of usage

Please click on this link to find examples of usage of this client.

API reference

Please click on this link for full API reference documentation .

Metadata

Release files for qe-api-client 3.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qe-api-client 3.1.0
File Size Uploaded Provenance
qe_api_client-3.1.0.tar.gz 44.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for qe-api-client 3.1.0
File Interpreter ABI Platform
qe_api_client-3.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 87.4 kB

Release files / qe_api_client-3.1.0.tar.gz

Download URL qe_api_client-3.1.0.tar.gz
Size 44.3 kB
Tags Source
SHA-256 checksum
How to use checksums
ac6b90c99bfe783ebe06a8007281fa5904f9eb77ef646709f4b4d4a90cac7a68
BLAKE2b-256 checksum
How to use checksums
7cd519b949f1843f7d285617f91c3650e128bcf41a4d5683576f113933896052
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / qe_api_client-3.1.0-py3-none-any.whl

Download URL qe_api_client-3.1.0-py3-none-any.whl
Size 43.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b8c40793e914847be3927ea254af6bc4bc311615be405680acbbcc6f547d8bb5
BLAKE2b-256 checksum
How to use checksums
943b6da60cc28da12f536c16f90a1b8a959b0c3c1e1173f80e24ea8ee3af7b54
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for qe-api-client 3.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page