Skip to content
RelationalAI Docs

Get Started with RAI in a Local Python Environment

This guide walks you through the steps to set up a local Python development environment with the relationalai package. This setup is ideal for developing, testing, and deploying applications built with RAI.

Install Python

Section titled “Install Python”

Select your operating system and follow the steps to install Python on your machine:

  1. Navigate to the Python 3.11 download page, scroll down to the Files section, and download the Windows installer (64-bit).

  2. Open the installer and follow the prompts to install Python 3.11. Check the box to add Python to your PATH.

  3. Open a terminal and verify that Python 3.11 is installed by running:

    Terminal window
    python --version

    The output should be similar to Python 3.11.9.

Install the relationalai Package

Section titled “Install the relationalai Package”

Create a new project directory and virtual environment and use pip to install the relationalai package:

Terminal window
mkdir rai-getting-started && cd rai-getting-started


# Create a virtual environment.
python -m venv .venv


# Activate the virtual environment.
.venv\Scripts\activate


# Install the relationalai package.
python -m pip install relationalai

Set Up Your Snowflake Connection

Section titled “Set Up Your Snowflake Connection”

Run rai init to connect to your Snowflake account and configure your project:

Terminal window
rai init

Follow the interactive prompts to enter your Snowflake credentials and choose the:

Run a Test Query

Section titled “Run a Test Query”

Verify that the relationalai package is installed and working correctly by running the following code:

import relationalai as rai


# Create a model named "MyFirstModel".
model = rai.Model("MyFirstModel")


# Send a test query.
with model.query() as select:
    response = select(1 + 1)


# The results are stored as a pandas DataFrame in the response.results attribute.
print(response.results)
#    v
# 0  2

Use Direct Access

Section titled “Use Direct Access”

By default, Python API calls are routed through Snowflake Service Functions, which adds some extra overhead to every request. Direct Access lets your code connect straight to the RAI Native App’s secure web address, skipping the middleman and making each call much faster—often by about 500ms. This is especially helpful for local development and rapid testing.

You enable direct access by setting use_direct_access = true in your raiconfig.toml profile and choosing an authenticator that fits your workflow:

The OAuth Authorization Code authentication method is best for interactive workflows. You’ll log in with your browser when you connect, just like signing in to a website. This is great for local development and testing.

Here’s an example raiconfig.toml file configured to use OAuth:

raiconfig.toml
[profile.default]
platform = "snowflake"
use_direct_access = true
authenticator = "oauth_authorization_code"
oauth_client_id = "<OAUTH_CLIENT_ID>"
oauth_redirect_uri = "<OAUTH_REDIRECT_URI>"  -- e.g. "http://localhost:8001/snowflake/oauth-redirect" (defined in the security integration)