feat: include postgrest in monorepo, finalize monorepo switch

.release-please-manifest.json

@@ -3,5 +3,6 @@
   "src/realtime": "2.7.0",
   "src/functions": "0.10.1",
   "src/storage": "0.12.1",
+  "src/postgrest": "1.1.1",
   "src/auth": "2.12.3"
 }

Makefile

@@ -1,6 +1,6 @@
 .PHONY: ci, default, pre-commit, clean, start-infra, stop-infra
 
-PACKAGES := functions realtime storage auth supabase
+PACKAGES := functions realtime storage auth postgrest supabase
 FORALL_PKGS = $(foreach pkg, $(PACKAGES), $(pkg).$(1))
 
 help::
@@ -17,19 +17,23 @@ help::
 	@echo "  pre-commit     -- Run pre-commit on all files"
 
 clean: $(call FORALL_PKGS,clean)
+	rm -rf dist .ruff_cache .pytest_cache
 help::
 	@echo "  clean          -- Delete cache files and coverage reports from tests"
 
 publish: $(call FORALL_PKGS,build)
 	uv publish
 
 # not all packages have infra, so just manually instantiate the ones that do for now
-start-infra: realtime.start-infra storage.start-infra auth.start-infra
+start-infra: realtime.start-infra storage.start-infra auth.start-infra postgrest.start-infra
 help::
-	@echo "  start-infra    -- Start all containers necessary for tests. NOTE: it is not necessary to this before running CI tests, they start the infra by themselves"
-stop-infra: realtime.stop-infra storage.stop-infra auth.stop-infra
+	@echo "  start-infra    -- Start all containers necessary for tests."
+	@echo "                    NOTE: it is not necessary to this command before running CI tests"
+
+stop-infra: realtime.stop-infra storage.stop-infra auth.stop-infra postgrest.stop-infra
 help::
-	@echo "  stop-infra     -- Stop all infra used by tests. NOTE: tests do leave their infra running, so run this to ensure all containers are stopped"
+	@echo "  stop-infra     -- Stop all infra used by tests."
+	@echo "                    NOTE: run this command to ensure all containers are stopped after tests"
 
 
 realtime.%:
@@ -44,6 +48,9 @@ storage.%:
 auth.%:
 	@$(MAKE) -C src/auth $*
 
+postgrest.%:
+	@$(MAKE) -C src/postgrest $*
+
 supabase.%:
 	@$(MAKE) -C src/supabase $*
 

README.md

@@ -1,11 +1,16 @@
 # `supabase-py`
 
-Python monorepo for all [Supabase](https://supabase.com) libraries. This is a work in progress, and currently these are the ones contained in this repository:
+[![CI](https://github.com/supabase/supabase-py/actions/workflows/ci.yml/badge.svg)](https://github.com/supabase/supabase-py/actions/workflows/ci.yml)
+[![Version](https://img.shields.io/pypi/v/supabase?color=%2334D058)](https://pypi.org/project/supabase)
+[![Coverage Status](https://coveralls.io/repos/github/supabase/supabase-py/badge.svg?branch=main)](https://coveralls.io/github/supabase/supabase-py?branch=main)
+
+Python monorepo for all [Supabase](https://supabase.com) libraries.
 
 - [supabase](src/supabase/README.md)
-- [realtime](src/realtime/README.md)
+- [realtime-py](src/realtime/README.md)
 - [supabase_functions](src/functions/README.md)
 - [storage3](src/storage/README.md)
+- [postgrest](src/postgrest/README.md)
 - [supabase_auth](src/auth/README.md)
 
 Relevant links:
@@ -15,7 +20,7 @@ Relevant links:
   - [GitHub OAuth in your Python Flask app](https://supabase.com/blog/oauth2-login-python-flask-apps)
   - [Python data loading with Supabase](https://supabase.com/blog/loading-data-supabase-python)
 
-## Set up a Local Development Environment
+## Local Development
 
 ### Clone the Repository
 
@@ -24,50 +29,52 @@ git clone https://github.com/supabase/supabase-py.git
 cd supabase-py
 ```
 
-### Create and Activate a Virtual Environment
+### Dependencies
+
+This repository relies on the following dependencies for development: 
+- `uv` for python project management.
+- `make` for command running.
+- `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 activating your virtual environment. For example, we like `uv`, `conda` and `nix`! Click [here](https://docs.python.org/3/library/venv.html) for more about Python virtual environments and working with [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment) and [uv](https://docs.astral.sh/uv/getting-started/features/). For nix, just install it with flakes enabled.
+### Use a Virtual Environment
+
+We recommend using a virtual environment, preferrably through `uv`, given it is currently the only tool that understands the workspace setup (you can read more about it in [the uv docs](https://docs.astral.sh/uv/concepts/projects/workspaces/)).
 
-Using uv:
 ```
 uv venv supabase-py
 source supabase-py/bin/activate
 uv sync
 ```
 
-Using venv (Python 3 built-in):
+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](https://github.com/pyproject-nix/uv2nix).
 
-```bash
-python3 -m venv env
-source env/bin/activate  # On Windows, use .\env\Scripts\activate
-```
+### Running tests and other commands
 
-Using conda:
+We use `make` to store and run the relevant commands. The structure is setup 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
 ```bash
-conda create --name supabase-py
-conda activate supabase-py
+make ci
 ```
+Which internally dispatches `make -C src/{package} tests` calls to each package in the monorepo.
 
-Using nix:
+You should also consider using
 ```bash
-nix develop
+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.
 
-### Local installation
-
-You can also install locally after cloning this repo. Install Development mode with `pip install -e`, which makes it editable, so when you edit the source code the changes will be reflected in your python module.
-
-## Badges
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?label=license)](https://opensource.org/licenses/MIT)
-[![CI](https://github.com/supabase/supabase-py/actions/workflows/ci.yml/badge.svg)](https://github.com/supabase/supabase-py/actions/workflows/ci.yml)
-[![Python](https://img.shields.io/pypi/pyversions/supabase)](https://pypi.org/project/supabase)
-[![Version](https://img.shields.io/pypi/v/supabase?color=%2334D058)](https://pypi.org/project/supabase)
-[![Codecov](https://codecov.io/gh/supabase/supabase-py/branch/develop/graph/badge.svg)](https://codecov.io/gh/supabase/supabase-py)
-[![Last commit](https://img.shields.io/github/last-commit/supabase/supabase-py.svg?style=flat)](https://github.com/supabase/supabase-py/commits)
-[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/supabase/supabase-py)](https://github.com/supabase/supabase-py/commits)
-[![Github Stars](https://img.shields.io/github/stars/supabase/supabase-py?style=flat&logo=github)](https://github.com/supabase/supabase-py/stargazers)
-[![Github Forks](https://img.shields.io/github/forks/supabase/supabase-py?style=flat&logo=github)](https://github.com/supabase/supabase-py/network/members)
-[![Github Watchers](https://img.shields.io/github/watchers/supabase/supabase-py?style=flat&logo=github)](https://github.com/supabase/supabase-py)
-[![GitHub contributors](https://img.shields.io/github/contributors/supabase/supabase-py)](https://github.com/supabase/supabase-py/graphs/contributors)
+Other relevant commands include
+```bash
+make pre-commit # run lints and formmating before commiting
+make stop-infra # stops all running containers from all packages
+make clean      # delete all intermediary files created by testing
+```
+All the sub packages command are available from the main root by prefixing the command with `{package_name}.`. Examples:
+```bash
+make realtime.tests # run only realtime tests
+make storage.clean # delete temporary files only in the storage package
+```

flake.nix

@@ -33,6 +33,7 @@
       pkgs.supabase-cli
       pkgs.uv
       pkgs.gnumake
+      pkgs.docker
     ];
     workspace = uv2nix.lib.workspace.loadWorkspace { workspaceRoot = ./.; };
 

pyproject.toml

@@ -4,6 +4,7 @@ members = [
   "src/functions",
   "src/supabase",
   "src/storage",
+  "src/postgrest",
   "src/auth"
 ]
 
@@ -12,6 +13,7 @@ realtime = { workspace = true }
 supabase_functions  = { workspace = true }
 supabase_auth = { workspace = true }
 storage3 = { workspace = true }
+postgrest = { workspace = true }
 supabase = { workspace = true }
 
 [tool.pytest.ini_options]

release-please-config.json

@@ -17,6 +17,10 @@
       "changelog-path": "src/storage/CHANGELOG.md",
       "release-type": "python"
     },
+    "src/postgrest": {
+      "changelog-path": "src/postgrest/CHANGELOG.md",
+      "release-type": "python"
+    },
     "src/supabase": {
       "changelog-path": "src/supabase/CHANGELOG.md",
       "release-type": "python"

src/auth/README.md

@@ -3,24 +3,30 @@
 [![CI](https://github.com/supabase-community/gotrue-py/actions/workflows/ci.yml/badge.svg)](https://github.com/supabase-community/gotrue-py/actions/workflows/ci.yml)
 [![Python](https://img.shields.io/pypi/pyversions/gotrue)](https://pypi.org/project/gotrue)
 [![Version](https://img.shields.io/pypi/v/gotrue?color=%2334D058)](https://pypi.org/project/gotrue)
-[![Coverage Status](https://coveralls.io/repos/github/supabase/auth-py/badge.svg?branch=main)](https://coveralls.io/github/supabase/auth-py?branch=main)
 
 This is a Python port of the [supabase js gotrue client](https://github.com/supabase/gotrue-js). The current state is that there is a features parity but with small differences that are mentioned in the section **Differences to the JS client**. As of December 14th, we renamed to repo from `gotrue-py` to `auth-py` to mirror the changes in the JavaScript library.
 
 ## Installation
 
-The package can be installed using pip or poetry:
+The package can be installed using pip, uv or poetry:
 
-### Poetry
+### Pip
 
 ```bash
-poetry add supabase_auth
+pip install supabase_auth
 ```
 
-### Pip
+
+### Uv
 
 ```bash
-pip install supabase_auth
+uv add supabase_auth
+```
+
+### Poetry
+
+```bash
+poetry add supabase_auth
 ```
 
 ## Features

src/auth/pyproject.toml

@@ -5,6 +5,9 @@ description = "Python Client Library for Supabase Auth"
 authors = [
   {name = "Joel Lee", email = "[email protected]" }
 ]
+maintainers = [
+  { name = "Leonardo Santiago", email = "[email protected]" }
+]
 readme = "README.md"
 license = "MIT"
 classifiers = [
@@ -20,9 +23,9 @@ dependencies = [
 ]
 
 [project.urls]
-homepage = "https://github.com/supabase/auth-py"
-repository = "https://github.com/supabase/auth-py"
-documentation = "https://github.com/supabase/auth-py"
+homepage = "https://github.com/supabase/supabase-py/tree/main/src/auth"
+repository = "https://github.com/supabase/supabase-py"
+documentation = "https://github.com/supabase/supabase-py/tree/main/src/auth"
 
 # [project.scripts]
 # gh-download = "scripts.gh-download:main"

src/functions/pyproject.toml

@@ -6,6 +6,9 @@ authors = [
   { name = "Joel Lee", email = "[email protected]" },
   { name = "Andrew Smith", email = "[email protected]" },
 ]
+maintainers = [
+  { name = "Leonardo Santiago", email = "[email protected]" }
+]
 license = "MIT"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -14,8 +17,10 @@ dependencies = [
   "strenum >=0.4.15",
 ]
 
+
 [project.urls]
 repository = "https://github.com/supabase/supabase-py"
+homepage = "https://github.com/supabase/supabase/tree/main/src/functions"
 
 [dependency-groups]
 tests = [

src/postgrest/.devcontainer/Dockerfile

@@ -0,0 +1,21 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.203.0/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT="3.10-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

src/postgrest/.devcontainer/devcontainer.json

@@ -0,0 +1,87 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.203.0/containers/python-3
+{
+    "name": "Python 3",
+    "runArgs": [
+        "--init"
+    ],
+    "build": {
+        "dockerfile": "Dockerfile",
+        "context": "..",
+        "args": {
+            // Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
+            // Append -bullseye or -buster to pin to an OS version.
+            // Use -bullseye variants on local on arm64/Apple Silicon.
+            "VARIANT": "3.10-bullseye",
+            // Options
+            "NODE_VERSION": "lts/*"
+        }
+    },
+    // Set *default* container specific settings.json values on container create.
+    "settings": {
+        "python.pythonPath": "/usr/local/bin/python",
+        "python.languageServer": "Pylance",
+        "python.linting.enabled": true,
+        "python.linting.flake8Enabled": true,
+        "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+        "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+        "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+        "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+        "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+        "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+        "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+        "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+        "python.analysis.diagnosticMode": "workspace",
+        "files.exclude": {
+            "**/.ipynb_checkpoints": true,
+            "**/.pytest_cache": true,
+            "**/*pycache*": true
+        },
+        "python.formatting.provider": "black",
+        "python.linting.flake8Args": [
+            "--max-line-length=88",
+            "--extend-ignore=E203"
+        ],
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": true
+        },
+        "python.sortImports.args": [
+            "--multi-line=3",
+            "--trailing-comma",
+            "--force-grid-wrap=0",
+            "--use-parentheses",
+            "--line-width=88",
+        ],
+        "markdownlint.config": {
+            "MD022": false,
+            "MD024": false,
+            "MD032": false,
+            "MD033": false
+        }
+    },
+    // Add the IDs of extensions you want installed when the container is created.
+    "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "ms-azuretools.vscode-docker",
+        "donjayamanne.githistory",
+        "felipecaputo.git-project-manager",
+        "github.copilot-nightly",
+        "eamodio.gitlens",
+        "davidanson.vscode-markdownlint"
+    ],
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+    // Use 'postCreateCommand' to run commands after the container is created.
+    // "postCreateCommand": "pip3 install --user -r requirements.txt",
+    // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+    "remoteUser": "vscode",
+    "features": {
+        "docker-in-docker": "latest",
+        "git": "latest",
+        "git-lfs": "latest",
+        "github-cli": "latest"
+    }
+}