supabase-py

Supabase client for Python. This mirrors the design of supabase-js

Installation

Recomended: First activate your virtual environment, with your favourites system. For example, we like poetry and conda!

PyPi installation

Now install the package.

pip install supabase

Local installation

You can also installing from after cloning this repo. Install like below to install in Development Mode, which means when you edit the source code the changes will be reflected in your python module.

pip install -e .

Usage

It's usually best practice to set your api key environment variables in some way that version control doesn't track them, e.g don't put them in your python modules! Set the key and url for the supabase instance in the shell, or better yet, use a dotenv file. Heres how to set the variables in the shell.

export SUPABASE_URL="my-url-to-my-awesome-supabase-instance"
export SUPABASE_KEY="my-supa-dupa-secret-supabase-api-key"

We can then read the keys in the python source code.

import os
from supabase_py import create_client, Client

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
email = "abcdde@gmail.com"
password = "password"
supabase: Client = create_client(url, key)
user = supabase.auth.sign_up(email, password)

Running Tests

Currently the test suites are in a state of flux. We are expanding our clients tests to ensure things are working, and for now can connect to this test instance, that is populated with the following table:

The above test database is a blank supabase instance that has populated the countries table with the built in countries script that can be found in the supabase UI. You can launch the test scripts and point to the above test database with the

SUPABASE_TEST_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYW5vbiIsImlhdCI6MTYxMjYwOTMyMiwiZXhwIjoxOTI4MTg1MzIyfQ.XL9W5I_VRQ4iyQHVQmjG0BkwRfx6eVyYB3uAKcesukg" \
SUPABASE_TEST_URL="https://tfsatoopsijgjhrqplra.supabase.co" \
pytest -x

See issues for what to work on

Rough roadmap:

• Wrap Postgrest-py
• Wrap Realtime-py
• Wrap Gotrue-py

Client Library

This is a sample of how you'd use [supabase-py]. Functions and tests are WIP

Authenticate

supabase.auth.signUp({
  "email": 'example@email.com',
  "password": 'example-password',
})

Sign-in

supabase.auth.signIn({
  "email": 'example@email.com',
  "password": 'example-password',
})

Sign-in(Auth provider). This is not supported yet

supabase.auth.signIn({
  // provider can be 'github', 'google', 'gitlab', or 'bitbucket'
  "provider": 'github'
})

Managing Data

supabase
  .from('countries')
  .select("
    name,
    cities (
      name
    )
  ")

Realtime Changes

mySubscription = supabase
  .from('countries')
  .on('*',  lambda x: print(x))
  .subscribe()

See Supabase Docs for full list of examples