chore: move supabase-py to a sub package

make `supabase-py` a sub package, and make the workspace root a
virtual workspace that contains no "main package". this is in order to
have more homogeneity around the packages, as before the `supabase-py`
was treated specially (pyproject in the root instead of in `src/supabase`).

Author: o-santi

README.md

@@ -1,6 +1,11 @@
 # `supabase-py`
 
-Python client for [Supabase](https://supabase.com)
+Python monorepo for all [Supabase](https://supabase.com) libraries.
+
+- [supabase](src/supabase/README.md)
+- [realtime](src/realtime/README.md)
+
+Relevant links:
 
 - Documentation: [supabase.com/docs](https://supabase.com/docs/reference/python/introduction)
 - Usage:
@@ -24,6 +29,7 @@ Using uv:
 ```
 uv venv supabase-py
 source supabase-py/bin/activate
+uv sync
 ```
 
 Using venv (Python 3 built-in):
@@ -40,154 +46,10 @@ conda create --name supabase-py
 conda activate supabase-py
 ```
 
-### PyPI installation
-
-Install the package (for Python >= 3.9):
-
-```bash
-# with pip
-pip install supabase
-
-# with conda
-conda install -c conda-forge supabase
-```
-
 ### 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.
 
-## Usage
-
-Set your Supabase environment variables in a dotenv file, or using the shell:
-
-```bash
-export SUPABASE_URL="my-url-to-my-awesome-supabase-instance"
-export SUPABASE_KEY="my-supa-dupa-secret-supabase-api-key"
-```
-
-Init client:
-
-```python
-import os
-from supabase import create_client, Client
-
-url: str = os.environ.get("SUPABASE_URL")
-key: str = os.environ.get("SUPABASE_KEY")
-supabase: Client = create_client(url, key)
-```
-
-Use the supabase client to interface with your database.
-
-### Sign-up
-
-```python
-user = supabase.auth.sign_up({ "email": users_email, "password": users_password })
-```
-
-### Sign-in
-
-```python
-user = supabase.auth.sign_in_with_password({ "email": users_email, "password": users_password })
-```
-
-### Insert Data
-
-```python
-data = supabase.table("countries").insert({"name":"Germany"}).execute()
-
-# Assert we pulled real data.
-assert len(data.data) > 0
-```
-
-### Select Data
-
-```python
-data = supabase.table("countries").select("*").eq("country", "IL").execute()
-
-# Assert we pulled real data.
-assert len(data.data) > 0
-```
-
-### Update Data
-
-```python
-data = supabase.table("countries").update({"country": "Indonesia", "capital_city": "Jakarta"}).eq("id", 1).execute()
-```
-
-### Update data with duplicate keys
-
-```python
-country = {
-  "country": "United Kingdom",
-  "capital_city": "London" # This was missing when it was added
-}
-
-data = supabase.table("countries").upsert(country).execute()
-assert len(data.data) > 0
-```
-
-### Delete Data
-
-```python
-data = supabase.table("countries").delete().eq("id", 1).execute()
-```
-
-### Call Edge Functions
-
-```python
-def test_func():
-  try:
-    resp = supabase.functions.invoke("hello-world", invoke_options={'body':{}})
-    return resp
-  except (FunctionsRelayError, FunctionsHttpError) as exception:
-    err = exception.to_dict()
-    print(err.get("message"))
-```
-
-### Download a file from Storage
-
-```python
-bucket_name: str = "photos"
-
-data = supabase.storage.from_(bucket_name).download("photo1.png")
-```
-
-### Upload a file
-
-```python
-bucket_name: str = "photos"
-new_file = getUserFile()
-
-data = supabase.storage.from_(bucket_name).upload("/user1/profile.png", new_file)
-```
-
-### Remove a file
-
-```python
-bucket_name: str = "photos"
-
-data = supabase.storage.from_(bucket_name).remove(["old_photo.png", "image5.jpg"])
-```
-
-### List all files
-
-```python
-bucket_name: str = "charts"
-
-data = supabase.storage.from_(bucket_name).list()
-```
-
-### Move and rename files
-
-```python
-bucket_name: str = "charts"
-old_file_path: str = "generic/graph1.png"
-new_file_path: str = "important/revenue.png"
-
-data = supabase.storage.from_(bucket_name).move(old_file_path, new_file_path)
-```
-
-
 ## Roadmap
 
 - [x] Wrap [Postgrest-py](https://github.com/supabase/postgrest-py/)
@@ -265,14 +127,6 @@ data = supabase.storage.from_(bucket_name).move(old_file_path, new_file_path)
 
 Contributing to the Python libraries are a great way to get involved with the Supabase community. Reach out to us on [Discord](https://discord.supabase.com) or on our [Github Discussions](https://github.com/orgs/supabase/discussions) page if you want to get involved.
 
-## Important: Proper Client Shutdown
-
-To ensure the Supabase client terminates correctly and to prevent resource leaks, you **must** explicitly call:
-
-```python
-client.auth.sign_out()
-```
-
 ### 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, which is populated with the following table:

flake.lock

@@ -0,0 +1,62 @@
+{
+  description = "realtime-py: a Realtime python client.";
+
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    pyproject-nix = {
+      url = "github:pyproject-nix/pyproject.nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+    uv2nix = {
+      url = "github:pyproject-nix/uv2nix";
+      inputs.pyproject-nix.follows = "pyproject-nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+    pyproject-build-systems = {
+      url = "github:pyproject-nix/build-system-pkgs";
+      inputs.pyproject-nix.follows = "pyproject-nix";
+      inputs.uv2nix.follows = "uv2nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+
+  outputs = { nixpkgs, pyproject-nix, uv2nix, pyproject-build-systems, ... }: let
+    for-all-systems = f:
+      nixpkgs.lib.genAttrs [
+        "x86_64-linux"
+        "aarch64-darwin"
+        "aarch64-linux"
+        "x86_64-darwin"
+      ] (system: f nixpkgs.legacyPackages.${system});
+
+    dev-tools = pkgs: [
+      pkgs.supabase-cli
+      pkgs.just
+      pkgs.uv
+    ];
+    workspace = uv2nix.lib.workspace.loadWorkspace { workspaceRoot = ./.; };
+
+    workspace-overlay = workspace.mkPyprojectOverlay {
+      sourcePreference = "wheel"; # or sourcePreference = "sdist";
+    };
+
+    python-for = pkgs: let
+      extensions = pkgs.lib.composeManyExtensions [
+        pyproject-build-systems.overlays.default
+        workspace-overlay
+      ];
+      base-python = pkgs.callPackage pyproject-nix.build.packages {
+        python = pkgs.python311;
+      };
+    in base-python.overrideScope extensions;
+  in {
+    devShells = for-all-systems (pkgs: let
+      python = python-for pkgs;
+      python-env = python.mkVirtualEnv "supabase-py" workspace.deps.all;
+    in {
+      default = pkgs.mkShell {
+        packages = [ python-env ] ++ (dev-tools pkgs);
+      };
+    });
+  };
+}

flake.nix

@@ -1,12 +1,15 @@
 # commands related to realtime
+[group("package")]
+[doc("realtime commands")]
 mod realtime "src/realtime/mod.just"
-# commands related to supabase
+[doc("supabase commands")]
+[group("package")]
 mod supabase "src/supabase/mod.just"
 
 [doc("Lists all available commands")]
 default:
     @just --list
-    
+
 [doc("Run all available tests")]
 test: realtime::pytest && supabase::pytest