knowipy 0.1.0

The official Python3 Knowi API SDK.

Python3 - Knowi API SDK (knowipy)

This repository houses the official Python SDK for use with Knowi.

Knowi is an augmented analytics platform that instantly transforms any data into insights and data driven actions.

About

• The Knowi API SDK is the simplest way to automate your Knowi instance
• The SDK streamlines the API programming experience, allowing you to significantly reduce your written code
• This SDK was written for Python3, and is not compatible with Python2
• This library requires Python 3.6 and above.
• Execute scripts via python3

Installation

We recommend using PyPI to install the Knowi SDK for Python

$ pip3 install knowipy

Note: You may need to use python3 before your commands to ensure you use the correct Python path. e.g. python3 --version

python --version

-- or --

python3 --version

Usage

• Retrieve your Client id/secret from your Knowi account

• Navigate to Settings -> Account Settings https://recordit.co/HAudn0LJ2E

from knowipy import Knowi
import os

# instantiate the client
knowi = Knowi(clientId=os.environ['KNOWI_CLIENT_ID'], clientSecret=os.environ['KNOWI_CLIENT_SECRET'])


# get list of dashboards
dashboard_list = knowi.dashboard_list()

# to refresh an existing query
query_refresh = knowi.query_refresh(queryId=1231)

Development

---

Getting Started

Assuming that you have Python3 and virtualenv installed, set up your environment and install the required dependencies like this instead of the pip3 install knowipy defined above:

 $ git clone https://github.com/ezeagwulae/knowi-python-sdk.git
    $ cd knowipy
    $ virtualenv venv
    ...
    $ . venv/bin/activate
    $ pip install -r requirements.txt
    $ pip install -e .