Let you access all your Data on HyperCube Data Platform
visit https://www.hcube.io
- Python 3.6.2
- Pip
The HyperAPI package requires the HyperAPI_routes package, which is included as a wheel in the repository.
.\resources\HyperAPI_routes-4-py3-none-any.whl
on windows
pip install --upgrade HyperAPI -r requirements.txt
on linux/mac
pip3 install --upgrade HyperAPI -r requirements.txt
Sample python code :
from hdp_lib_api import Router
api = Router(token="<USER_TOKEN>", url="https://trial.hcube.io")
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 bdist_wheel
on linux/mac
python setup.py 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.
From the Repository root folder, install the HyperAPI_routes package first: on windows
pip install resources/HyperAPI_routes-4-py3-none-any.whl
on linux/mac
pip3 install resources/HyperAPI_routes-4-py3-none-any.whl
The HyperAPI wheel can then 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
- Option 1: run python from the source forlder.
- Option 2: add the HyperAPI folder to the python path.
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
This operation requiert a devops intervention
python -m h3cli -m security --login <mail adress>
# choose HyperCubeDevOps
python -m h3cli -m security --assume 400837748978/DevCubeAdmin
aws s3 cp s3://hyperapi.hcube.cool/<version of the api> ./ --recursive
python -m h3cli -m security --login <mail adress>
python -m h3cli -m security --assume HyperCubeAdmin
aws s3 cp ./<version of the api> s3://hyperapi-doc/<version of the api> --recursive