Installing and setting up the SDK

Installing RapidCanvas SDK allows Data Practitioners to interact with the RapidCanvas platform through a client side notebook interface. The SDK comes with all the necessary packages to connect, interact, create and execute projects directly from your notebook on RapidCanvas. RapidCanvas also provides a user-friendly interface to access the projects built in the notebook.

Prerequisites

To install the SDK, you must have the python version greater than 3.7 installed on your computer. Below are instructions to check the version of python in various operating systems. Please note that the platform supports Python versions from 3.7 to 3.11. Python 3.12 is yet not supported.

Mac OS:

Mac comes pre-built with Python. Check the version of python that is installed on your Mac device by entering the following command in the terminal.

which python

If the version of python is less than 3.7, install the latest version. To install the latest version of python click here.

Windows and Linux:

You need to check whether python is installed or your Windows or Linux device. To check the version of python, enter the following command in the command prompt or terminal.

python –version

If you see no such command error on your device, install the latest version of python. To install the latest version of python, click here.

What to consider before SDK installation?

After installing the python version on your device, you are good to install the SDK. However, we recommend using the virtual environment so that dependencies don’t conflict with your local directory.

To use the virtual environment open your terminal or command prompt and perform the following action.

  1. Enter the following command.

pip3 install virtualenv

It installs the isolated Python package that enables you to use a separate environment without affecting other installed software.

  1. Create a directory for your virtual environment. On Mac OS and Linux, enter the following command.

virtualenv <directoryname> -p python3

For example, you can name your directory <rapidcanvas>, then command looks like:

virtualenv rapidcanvas -p python3

On Windows, enter the following command on the command prompt.

python -m venv

cd <directoryname>

By using the above command, a new directory will be created in your local machine.

  1. Activate the virtual environment you created. On Mac OS and Linux, enter the following command.

source <directoryname>/bin/activate

To deactivate, type

deactivate

Suppose you chose <rapidcanvas>, then the command line looks like:

source rapidcanvas/bin/activate

On Windows, enter the following command on command prompt.

.venv\Scripts\activate

To deactivate, type

deactivate

How to install an SDK to access RapidCanvas?

Now you can install the RapidCanvas SDK to start using the client-side notebook interface. The SDK installs a set of python packages that helps you interact, create, and execute the projects directly from your Jupyter notebook. With RapidCanvas SDK, you can streamline your workflow and get started on your projects faster than ever before.

  1. Install the pip using the following command on the terminal.

pip install --extra-index-url=https://us-central1-python.pkg.dev/rapidcanvas-361003/pypi/simple utils==1.6

If you want to use jupyter notebook to interact with RapidCanvas, you can install the same by using this command

pip3 install jupyter notebook

On Windows, enter the following command on the command prompt.

pip install --extra-index-url=https://us-central1-python.pkg.dev/rapidcanvas-361003/pypi/simple utils==1.6

You have successfully installed the RapidCanvas SDK.