supabase-py
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.
File Explorer
Download Latest Version (.zip)- devcontainer.json
- Dockerfile
- bug_report.yml
- feature_request.yml
- ci.yml
- conventional-commits.yml
- stale.yml
- validate-capabilities.yml
- CODEOWNERS
- dependabot.yml
- conf.py
- index.rst
- make.bat
- Makefile
- query_builder.rst
- storage_bucket.rst
- devcontainer.json
- Dockerfile
- api.rst
- client.rst
- index.rst
- index.rst
- conf.py
- gotrue.rst
- index.rst
- modules.rst
- make.bat
- Makefile
- 00-schema.sql
- docker-compose.yml
- gh-download.py
- run-unasync.py
- __init__.py
- gotrue_admin_api.py
- gotrue_admin_mfa_api.py
- gotrue_admin_oauth_api.py
- gotrue_base_api.py
- gotrue_client.py
- gotrue_mfa_api.py
- storage.py
- __init__.py
- gotrue_admin_api.py
- gotrue_admin_mfa_api.py
- gotrue_admin_oauth_api.py
- gotrue_base_api.py
- gotrue_client.py
- gotrue_mfa_api.py
- storage.py
- __init__.py
- constants.py
- errors.py
- helpers.py
- py.typed
- timer.py
- types.py
- version.py
- __init__.py
- clients.py
- test_gotrue.py
- test_gotrue_admin_api.py
- test_utils.py
- __init__.py
- clients.py
- test_gotrue.py
- test_gotrue_admin_api.py
- test_utils.py
- __init__.py
- conftest.py
- test_helpers.py
- CHANGELOG.md
- MAINTAINERS.md
- Makefile
- pyproject.toml
- README.md
- __init__.py
- functions_client.py
- __init__.py
- functions_client.py
- __init__.py
- errors.py
- py.typed
- utils.py
- version.py
- __init__.py
- test_function_client.py
- __init__.py
- test_function_client.py
- __init__.py
- test_client.py
- test_errors.py
- test_utils.py
- CHANGELOG.md
- conftest.py
- Makefile
- pyproject.toml
- README.md
- run-unasync.py
- uv.lock
- devcontainer.json
- Dockerfile
- client.rst
- exceptions.rst
- filters.rst
- index.rst
- request_builders.rst
- responses.rst
- types.rst
- basic_queries.rst
- index.rst
- logging.rst
- conf.py
- index.rst
- make.bat
- Makefile
- requirements.txt
- docker-compose.yaml
- init.sql
- __init__.py
- client.py
- request_builder.py
- __init__.py
- client.py
- request_builder.py
- __init__.py
- base_client.py
- base_request_builder.py
- constants.py
- exceptions.py
- py.typed
- types.py
- utils.py
- version.py
- __init__.py
- client.py
- test_client.py
- test_filter_request_builder.py
- test_filter_request_builder_integration.py
- test_query_request_builder.py
- test_request_builder.py
- __init__.py
- client.py
- test_client.py
- test_filter_request_builder.py
- test_filter_request_builder_integration.py
- test_query_request_builder.py
- test_request_builder.py
- __init__.py
- test_utils.py
- CHANGELOG.md
- LICENSE
- Makefile
- pyproject.toml
- README.md
- run-unasync.py
- 20240810125543_init.sql
- 20260601000000_grant_api_access.sql
- .gitignore
- config.toml
- seed.sql
- __init__.py
- channel.py
- client.py
- presence.py
- push.py
- timer.py
- __init__.py
- channel.py
- client.py
- presence.py
- __init__.py
- exceptions.py
- message.py
- py.typed
- transformers.py
- types.py
- utils.py
- version.py
- test_connection.py
- test_presence.py
- test_timer.py
- CHANGELOG.md
- Makefile
- pyproject.toml
- README.md
- 20240513232811_bucket_rls_policies.sql
- .gitignore
- config.toml
- seed.sql
- __init__.py
- analytics.py
- bucket.py
- client.py
- file_api.py
- request.py
- vectors.py
- __init__.py
- analytics.py
- bucket.py
- client.py
- file_api.py
- request.py
- vectors.py
- __init__.py
- constants.py
- exceptions.py
- py.typed
- types.py
- utils.py
- version.py
- __init__.py
- conftest.py
- test_bucket.py
- test_client.py
- __init__.py
- conftest.py
- test_bucket.py
- test_client.py
- __init__.py
- test_client.py
- test_exceptions.py
- test_utils.py
- tests.env
- utils.py
- CHANGELOG.md
- MAINTAINERS.md
- Makefile
- pyproject.toml
- README.md
- run-unasync.py
- __init__.py
- auth_client.py
- client.py
- __init__.py
- auth_client.py
- client.py
- __init__.py
- client_options.py
- __init__.py
- client.py
- py.typed
- types.py
- version.py
- __init__.py
- test_client.py
- __init__.py
- test_client.py
- __init__.py
- conftest.py
- test_function_configuration.py
- test_realtime.py
- tests.env
- CHANGELOG.md
- LICENSE
- Makefile
- pyproject.toml
- README.md
- run-unasync.py
- .coveragerc
- .gitignore
- .release-please-manifest.json
- .sdk-parse-ignore
- CHANGELOG.md
- CONTRIBUTING.md
- flake.lock
- flake.nix
- LICENSE
- MAINTAINERS.md
- Makefile
- pyproject.toml
- README.md
- release-please-config.json
- sdk-compliance.yaml
- uv.lock
# Installation Guide
1. Get the code
git clone https://github.com/supabase/supabase-py
Downloads the entire project code from GitHub to your computer.
cd supabase-py
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f src/auth/infra/docker-compose.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Python
EasyPrerequisites
pip install .
Installs the package published on PyPI directly β no need to clone the source.
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make ci
Compiles the code based on the generated build configuration to produce an executable.
make ci -jN # where N is the number of max concurrent jobs, or just -j for infinite jobs
Compiles the code based on the generated build configuration to produce an executable.
make install-hooks # install all commit hooks into the local .git folder
Compiles the code based on the generated build configuration to produce an executable.
make stop-infra # stops all running containers from all packages
Compiles the code based on the generated build configuration to produce an executable.
make clean # delete all intermediary files created by testing
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)