Metadata-Version: 2.1
Name: qlik_sense
Version: 0.1.0
Summary: This library is a wrapper around the Qlik Sense APIs
Home-page: https://github.com/mikealfare/qlik_sense
License: UNKNOWN
Keywords: QlikSense Qlik Sense
Author: Mike Alfare
Author-email: alfare@gmail.com
Requires-Python: >=3.7,<4
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: requests
Requires-Dist: requests_ntlm
Requires-Dist: urllib3
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Requires-Dist: sphinx_rtd_theme; extra == "doc"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: doc
Provides-Extra: test

# Qlik Sense

**This library provides tools to interact with Qlik Sense's APIs natively in python.**

---

# Overview

This library is being developed so that Qlik Sense applications can be worked into a larger
python workflow more easily. While Qlik's API could be used directly, this streamlines the process.

# Requirements

- Python 3.7+
- requests
- requests_ntlm
- urllib3

# Installation

This package is hosted on PyPI:

```shell script
pip install qlik_sense
```

# Examples

Use this library to reload a Qlik Sense app:
```python
from qlik_sense import api

qs = api.QlikSense(host='HOST_NAME', certificate='CERT_FILE_PATH')

app = qs.get_app_by_name_and_stream(app_name='Rate Monitor', stream_name='Actuarial')
qs.reload_app(guid=app.guid)
```

# Acknowledgements

This package was inspired by Rafael Sanz's work:

https://github.com/rafael-sanz/qsAPI/blob/master/qsAPI.py

I would like to acknowledge the work he spent to figure out all of the logistics of Qlik Sense's APIs.
I redeployed a modified version of his Controller class as the core Session class in the ORM for this library and
built functionality around that class.

# Full Documentation

For the full documentation, please visit: https://qlik_sense.readthedocs.io/en/latest/
