RapidCanvas Docs
  • Welcome
  • GETTING STARTED
    • Quick start guide
    • Introduction to RapidCanvas
    • RapidCanvas Concepts
    • Accessing the platform
  • BASIC
    • Projects
      • Projects Overview
        • Creating a project
        • Reviewing the Projects listing page
        • Duplicating a Project
        • Modifying the project settings
        • Deleting Project(s)
        • Configuring global variables at the project level
        • Working on a project
        • Generating the about content for the project
        • Generating AI snippets for each node on the Canvas
        • Marking & Unmarking a Project as Favorite
      • Canvas overview
        • Shortcut options on canvas
        • Queuing the Recipes
        • Bulk Deletion of Canvas Nodes
        • AI Guide
      • Recipes
        • AI-assisted recipe
        • Rapid model recipe
        • Template recipe
        • Code Recipe
        • RAG Recipes
      • Scheduler overview
        • Creating a scheduler
        • Running the scheduler manually
        • Managing schedulers in a project
        • Viewing the schedulers in a project
        • Viewing the run history of a specific scheduler
        • Publishing the updated data pipeline to selected jobs from canvas
        • Fetching the latest data pipeline to a specific scheduler
        • Comparing the canvas of the scheduler with current canvas of the project
      • Predictions
        • Manual Prediction
        • Prediction Scheduler
      • Segments and Scenarios
      • DataApps
        • Model DataApp
        • Project Canvas Datasets
        • Custom Uploaded Datasets
        • SQL Sources
        • Documents and PDFs
        • Prediction Service
        • Scheduler
        • Import DataApp
    • Connectors
      • Importing dataset(s) from the local system
      • Importing Text Files from the Local System
      • Connectors overview
      • Connect to external connectors
        • Importing data from Google Cloud Storage (GCS)
        • Importing data from Amazon S3
        • Importing data from Azure Blob
        • Importing data from Mongo DB
        • Importing data from Snowflake
        • Importing data from MySQL
        • Importing data from Amazon Redshift
        • Importing data from Fivetran connectors
    • Workspaces
      • User roles and permissions
    • Artifacts & Models
      • Adding Artifacts at the Project Level
      • Adding Models at the Project Level
      • Creating an artifact at the workspace level
      • Managing artifacts at the workspace level
      • Managing Models at the Workspace Level
      • Prediction services
    • Environments Overview
      • Creating an environment
      • Editing the environment details
      • Deleting an environment
      • Monitoring the resource utilization in an environment
  • ADVANCED
    • Starter Guide
      • Quick Start
    • Setup and Installation
      • Installing and setting up the SDK
    • Helper Functions
    • Notebook Guide
      • Introduction
      • Create a template
      • Code Snippets
      • DataApps
      • Prediction Service
      • How to
        • How to Authenticate
        • Create a new project
        • Create a Custom Environment
        • Add a dataset
        • Add a recipe to the dataset
        • Manage cloud connection
        • Code recipes
        • Display a template on the UI
        • Create Global Variables
        • Scheduler
        • Create new scenarios
        • Create Template
        • Use a template in a flow notebook
      • Reference Implementations
        • DataApps
        • Artifacts
        • Connectors
        • Feature Store
        • ML model
        • ML Pipeline
        • Multiple Files
      • Sample Projects
        • Model build and predict
    • Rapid Rag
  • Additional Reading
    • Release Notes
      • May 14, 2025
      • April 21, 2025
      • April 01, 2025
      • Mar 18, 2025
      • Feb 27, 2025
      • Jan 27, 2025
      • Dec 26, 2024
      • Nov 26, 2024
      • Oct 24, 2024
      • Sep 11, 2024
        • Aug 08, 2024
      • Aug 29, 2024
      • July 18, 2024
      • July 03, 2024
      • June 19, 2024
      • May 30, 2024
      • May 15, 2024
      • April 17, 2024
      • Mar 28, 2024
      • Mar 20, 2024
      • Feb 28, 2024
      • Feb 19, 2024
      • Jan 30, 2024
      • Jan 16, 2024
      • Dec 12, 2023
      • Nov 07, 2023
      • Oct 25, 2023
      • Oct 01, 2024
    • Glossary
Powered by GitBook
On this page
  • Prerequisites
  • Mac OS
  • Windows and Linux
  • What to consider before SDK installation?
  • How to install an SDK to access RapidCanvas?
  1. ADVANCED
  2. Setup and Installation

Installing and setting up the SDK

PreviousSetup and InstallationNextHelper Functions

Last updated 1 month ago

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 3.7 or above installed on your computer. Below are instructions to check the version of python in various operating systems.

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 .

Windows and Linux

You need to check whether python is installed on 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 .

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.

  2. 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 the 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.

  3. 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==0.16

    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==0.16

You have successfully installed the RapidCanvas SDK.

here
here