gem-hunter
Language: Python
Python Client for Supabase. Query Postgres from Flask, Django, FastAPI. Python user authentication, security policies, edge functions, file storage, and realtime data streaming. Good first issue.
Python monorepo for all Supabase libraries.
Relevant links:
supabase-py only guarantees compatibility with the latest release of each Supabase service, unless a minimum supported version is explicitly listed below.
Older service releases are supported on a best-effort basis, but compatibility is not guaranteed.
If you self-host Supabase, we recommend upgrading your services to their latest releases when upgrading the SDK.
| Service | SDK package | Server releases | Lowest supported version |
|---|---|---|---|
| Auth | supabase_auth |
supabase/auth | Latest release |
| Storage | storage3 |
supabase/storage | Latest release |
| Functions | supabase_functions |
supabase/edge-runtime | Latest release |
| PostgREST | postgrest |
PostgREST/postgrest | Latest release |
| Realtime | realtime |
supabase/realtime | Latest release |
git clone https://github.com/supabase/supabase-py.git
cd supabase-pyThis repository relies on the following dependencies for development:
uv for python project management.make for running project commands.docker for both postgrest and auth test containers.supabase-cli for both storage and realtime test containers.All of these dependencies are included in the nix shell environment, through flake.nix. If you've got nix installed, you may prefer to use it through nix develop.
We recommend using a virtual environment, preferably through uv, given it is currently the only tool that understands the workspace setup (you can read more about it in the uv docs).
uv venv supabase-py
source supabase-py/bin/activate
uv sync
If you're using nix, the generated python executable should have the correct dependencies installed for the whole workspace, given it is derived from the root's pyproject.toml using uv2nix.
We use make to store and run the relevant commands. The structure is set up such that each sub package can individually set its command in its own Makefile, and the job of the main Makefile 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 dispatches make -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 jobsTo 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 folder make stop-infra # stops all running containers from all packages make 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 tests make storage.clean # delete temporary files only in the storage package