ecarlettihc / hyperapi

HyperCube API

Let you access all your Data on HyperCube Data Platform

visit https://www.hcube.io

Requirements

• Python 3.6.2
• Pip

User Documentation

Direct link

Quick installation

on windows

pip install --upgrade HyperAPI

on linux/mac

pip3 install --upgrade HyperAPI

Sample python code :

from HyperAPI.hdp_api import Router
api = Router(token="USER_TOKEN", url="https://trial.hcube.io")

Dev Documentation

Direct link

Building and installing the HyperAPI module manually

Building the python wheel

From the repository root folder, run the following command lines:

Set an environment variable PACKAGE_VERSION the define the version number for the HyperAPI.

on windows

set PACKAGE_VERSION=x

on linux/mac

export PACKAGE_VERSION=x

Generate the HyperAPI wheel file.

on windows

python setup.py sdist bdist_wheel

on linux/mac

python setup.py sdist bdist_wheel

The file will be generated on the in the /dist folder and be named HyperAPI-x-py3-none-any.whl x being the provided version number.

Installing the python wheel

The wheel can be installed directly using pip:

on windows

pip install /dist/HyperAPI-_x_-py3-none-any.whl

on linux/mac

pip3 install /dist/HyperAPI-_x_-py3-none-any.whl

Using the module from the source files

• Option 1: run python from the source forlder:
• Option 2: add the HyperAPI folder to the python path:

Option 2

Running Tests

From the Repository root folder run the following command line:

on windows

python -m unittest discover -s tests -p "*_test.py" -v

on linux/max

python3 -m unittest discover -s tests -p "*_test.py" -v