Merge pull request #5 from J0/master

Miscellaneous updates from downstream

Author: J0

.gitignore

@@ -1,3 +1,24 @@
+tags
+## Vim stuff
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
 .idea
 
 # Byte-compiled / optimized / DLL files
@@ -16,7 +37,6 @@ dist/
 downloads/
 eggs/
 .eggs/
-lib/
 lib64/
 parts/
 sdist/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Supabase
+Copyright (c) 2020 Joel Lee
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,13 +1,113 @@
 # supabase-py
 
-Supabase client for Python.
+[![Documentation Status](https://readthedocs.org/projects/gotrue-py/badge/?version=latest)](https://gotrue-py.readthedocs.io/en/latest/?badge=latest)
 
-### See issues for what to work on
+Supabase client for Python. This mirrors the design of [supabase-js](https://github.com/supabase/supabase-js/blob/master/README.md)
 
-Rough roadmap:
+## Installation
+
+**Recomended:** First activate your virtual environment, with your favourites system. For example, we like `poetry` and `conda`!
+
+#### PyPi installation
+Now install the package.
+```bash
+pip install supabase
+```
+
+#### Local installation
+You can also installing from after cloning this repo. Install like below to install in Development Mode, which means when you edit the source code the changes will be reflected in your python module.
+```bash 
+pip install -e .
+```
+
+## Usage
+It's usually best practice to set your api key environment variables in some way that version control doesn't track them, e.g don't put them in your python modules! Set the key and url for the supabase instance in the shell, or better yet, use a dotenv file. Heres how to set the variables in the shell.
+```bash
+export SUPABASE_URL="my-url-to-my-awesome-supabase-instance"
+export SUPABASE_KEY="my-supa-dupa-secret-supabase-api-key"
+```
 
+We can then read the keys in the python source code.
+```python
+import os
+from supabase_py import create_client, Client
+
+url: str = os.environ.get("SUPABASE_URL")
+key: str = os.environ.get("SUPABASE_KEY")
+email = "[email protected]"
+password = "password"
+supabase: Client = create_client(url, key)
+user = supabase.auth.sign_up(email, password)
+```
+
+### 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, that is populated with the following table:
+<p align="center">
+  <img width="720" height="481" src="https://i.ibb.co/Bq7Kdty/db.png">
+</p>
+
+The above test database is a blank supabase instance that has populated the `countries` table with the built in countries script that can be found in the supabase UI. You can launch the test scripts and point to the above test database with the 
+```bash
+SUPABASE_TEST_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYW5vbiIsImlhdCI6MTYxMjYwOTMyMiwiZXhwIjoxOTI4MTg1MzIyfQ.XL9W5I_VRQ4iyQHVQmjG0BkwRfx6eVyYB3uAKcesukg" \
+SUPABASE_TEST_URL="https://tfsatoopsijgjhrqplra.supabase.co" \
+pytest -x
+```
+
+### See issues for what to work on
+Rough roadmap:
 - [ ] Wrap [Postgrest-py](https://github.com/supabase/postgrest-py/)
-- [ ] Write Realtime-py (Use [realtime-js](https://github.com/supabase/realtime-js) as reference implementation) (implementation started by  @Jeffery Kwoh @Joel and @Lionell Loh)
-- [ ] Wrap Realtime-py (Use [supabase-js](https://github.com/supabase/supabase-js) as reference implementation)
-- [ ] Write Gotrue-py (for auth) (Use [gotrue-js](https://github.com/netlify/gotrue-js) as reference implementation)
-- [ ] Wrap Gotrue-py
+- [ ] Wrap [Realtime-py](https://github.com/supabase/realtime-py)
+- [x] Wrap [Gotrue-py](https://github.com/J0/gotrue-py)
+
+
+
+### Client Library
+This is a sample of how you'd use [supabase-py]. Functions and tests are WIP
+
+## Authenticate 
+```
+supabase.auth.signUp({
+  "email": '[email protected]',
+  "password": 'example-password',
+})
+```
+
+
+## Sign-in
+```
+supabase.auth.signIn({
+  "email": '[email protected]',
+  "password": 'example-password',
+})
+```
+
+
+## Sign-in(Auth provider). This is not supported yet
+```
+supabase.auth.signIn({
+  // provider can be 'github', 'google', 'gitlab', or 'bitbucket'
+  "provider": 'github'
+})
+```
+
+
+## Managing Data
+```
+supabase
+  .from('countries')
+  .select("
+    name,
+    cities (
+      name
+    )
+  ")
+```
+
+## Realtime Changes
+```
+mySubscription = supabase
+  .from('countries')
+  .on('*',  lambda x: print(x))
+  .subscribe()
+  ```
+See [Supabase Docs](https://supabase.io/docs/guides/client-libraries) for full list of examples

pyproject.toml

@@ -2,15 +2,22 @@
 name = "supabase-py"
 version = "0.0.1"
 description = "Supabase client for Python."
-authors = ["Lương Quang Mạnh <[email protected]>"]
+authors = ["Joel Lee <[email protected]>"]
 license = "MIT"
 
 [tool.poetry.dependencies]
-python = "^3.7"
+python = "^3.7.1"
 postgrest-py = "^0.3.2"
+realtime-py="^0.1.0"
+gotrue="0.1.2"
+pytest="6.2.2"
+supabase-realtime-py="0.1.1a0"
 
 [tool.poetry.dev-dependencies]
 
 [build-system]
-requires = ["poetry>=0.12"]
+requires = [
+    "poetry>=0.12",
+    "setuptools>=30.3.0,<50",
+]
 build-backend = "poetry.masonry.api"

setup.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python
+
+import setuptools
+
+if __name__ == "__main__":
+    setuptools.setup()

supabase_py/__init__.py

@@ -0,0 +1,9 @@
+# Retain module level imports for structured imports in tests etc.
+from . import lib
+from . import client
+
+# Open up the client and function as an easy import.
+from .client import Client, create_client
+
+
+__version__ = "0.0.1"