Repository files navigation

Python monorepo for allSupabase libraries.

• supabase
• realtime-py
• supabase_functions
• storage3
• postgrest
• supabase_auth

Relevant links:

• Documentation:supabase.com/docs
• Usage:
  • GitHub OAuth in your Python Flask app
  • Python data loading with Supabase

git clone https://github.com/supabase/supabase-py.gitcd supabase-py

This repository relies on the following dependencies for development:

• uv for python project management.
• make for running project commands.
• docker for bothpostgrest andauth test containers.
• supabase-cli for bothstorage andrealtime test containers.

All of these dependencies are included in the nix shell environment, throughflake.nix. If you've gotnix installed, you may prefer to use it throughnix develop.

We recommend using a virtual environment, preferably throughuv, given it is currently the only tool that understands the workspace setup (you can read more about it inthe uv docs).

uv venv supabase-pysource supabase-py/bin/activateuv sync

If you're using nix, the generatedpython executable should have the correct dependencies installed for the whole workspace, given it is derived from the root'spyproject.toml usinguv2nix.

We usemake to store and run the relevant commands. The structure is set up such that each sub package can individually set its command in its ownMakefile, and the job of the mainMakefile is just coordinate calling each of them.

For instance, in order to run all tests of all packages, you should use the following root command

make ci

Which internally dispatchesmake -C src/{package} tests calls to each package in the monorepo.

You should also consider using

make ci -jN# where N is the number of max concurrent jobs, or just -j for infinite jobs

To run each of the packages' tests in parallel. This should be generally faster than running in 1 job, but has the downside of messing up the CLI output, so parsing error messages might not be easy.

Other relevant commands include

make install-hooks# install all commit hooks into the local .git foldermake stop-infra# stops all running containers from all packagesmake clean# delete all intermediary files created by testing

All the subpackages command are available from the main root by prefixing the command with{package_name}.. Examples:

make realtime.tests# run only realtime testsmake storage.clean# delete temporary files only in the storage package