Python API Install

​

Python API Installation

Depending on the target operating system, a Python virtual environment may need to be installed first:

• Python Virtual Environment

The native Kinetica Python API is accessible through the following means:

• PyPI
• Git

​

Python Virtual Environment

A Python virtual environment is necessary to install in an operating environment where Python is externally managed.

1. Install a Python virtual environment:
   python3 -m venv .venv
   
2. Activate the Python virtual environment:
   source .venv/bin/activate
   

​

PyPI

1. Install the API:
   pip3 install gpudb
   
2. Test the installation:
   python3 -c "import gpudb;print('Import Successful')"
   
   If Import Successful is displayed, the API has been installed as is ready for use.

​

Git

1. In the desired directory, run the following, but be sure to replace <kinetica-version> with the name of the installed Kinetica version, e.g., v7.2:
   git clone -b release/<kinetica-version> --single-branch https://github.com/kineticadb/kinetica-api-python.git
   
2. Change directory into the newly downloaded repository:
   cd kinetica-api-python
   
3. In the root directory of the unzipped repository, install the Kinetica API:
   sudo pip3 install .
   
4. Test the installation (Python3 is necessary for running the API example):
   python3 examples/example.py