Bring closer to pairity with supabase/gotrue-js

.github/workflows/ci.yml

@@ -14,10 +14,8 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         python-version: [3.6, 3.7, 3.8, 3.9]
-
-
     runs-on: ${{ matrix.os }}
-
+    # TODO(fedden): We need to discuss these steps: We could just use a test-supabase instance or we could update the docker image and use that for the tests.
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
@@ -45,4 +43,5 @@ jobs:
         time: "5s"
     - name: Test with pytest
       run: |
-        pytest
+        pytest -sx
+

.gitignore

@@ -0,0 +1,162 @@
+.mypy_cache/
+__pycache__/
+tags
+
+# 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~
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

README.md

@@ -1,33 +1,84 @@
-
 # Gotrue-py
-
-## Status: POC
-This is a hacky `gotrue-py` client conceived during a very draggy class. It was developed against the [supabase](https://github.com/supabase/gotrue) fork of netlify's gotrue. The design mirrors that of [GoTrue-elixir](https://github.com/joshnuss/gotrue-elixir)
+This is a Python port of the [supabase js gotrue client](https://github.com/supabase/gotrue-js/). The current status is that there is not complete feature pairity when compared with the js-client, but this something we are working on.
 
 ## Installation
+We are still working on making the go-true python library more user-friendly. For now here are some sparse notes on how to install the module
+
+### Poetry
+```bash
+poetry add gotrue
+```
 
-Here's how you'd install the library with gotrue 
-### With Poetry
+### Pip
+```bash
+pip install gotrue
+```
 
-`poetry add gotrue`
+## Differences to the JS client
+It should be noted there are differences to the [JS client](https://github.com/supabase/gotrue-js/). If you feel particulaly strongly about them and want to motivate a change, feel free to make a GitHub issue and we can discuss it there. 
 
-### With pip
-`pip3 install gotrue`
+Firstly, feature pairity is not 100% with the [JS client](https://github.com/supabase/gotrue-js/). In most cases we match the methods and attributes of the [JS client](https://github.com/supabase/gotrue-js/) and api classes, but is some places (e.g for browser specific code) it didn't make sense to port the code line for line.
 
+There is also a divergence in terms of how errors are raised. In the [JS client](https://github.com/supabase/gotrue-js/), the errors are returned as part of the object, which the user can choose to process in whatever way they see fit. In this Python client, we raise the errors directly where they originate, as it was felt this was more Pythonic and adhered to the idioms of the language more directly.
 
-### Usage
+In JS we return the error, but in Python we just raise it.
+```js
+const { data, error } = client.sign_up(...)
 ```
-import gotrue
 
-client = gotrue.Client("www.genericauthwebsite.com")
-credentials = {"email": "anemail@gmail.com", "password": "gmebbnok"}
-client.sign_up(credentials)
-client.sign_in(credentials)
+The other key difference is we do not use pascalCase to encode variable and method names. Instead we use the snake_case convention adopted in the Python language. 
+
+## Usage
+To instanciate the client, you'll need the URL and any request headers at a minimum.
+```python
+from gotrue import Client
+
+headers = {
+    "apiKey": "my-mega-awesome-api-key",
+    # ... any other headers you might need.
+}
+client: Client = Client(url="www.genericauthwebsite.com", headers=headers)
+```
 
+To send a magic email link to the user, just provide the email kwarg to the `sign_in` method:
+```python
+user: Dict[str, Any] = client.sign_up(email="example@gmail.com")
 ```
 
+To login with email and password, provide both to the `sign_in` method:
+```python
+user: Dict[str, Any] = client.sign_up(email="example@gmail.com", password="*********")
+```
+
+To sign out of the logged in user, call the `sign_out` method. We can then assert that the session and user are null values.
+```python
+client.sign_out()
+assert client.user() is None
+assert client.session() is None
+```
+
+We can refesh a users session.
+```python
+# The user should already be signed in at this stage.
+user = client.refresh_session()
+assert client.user() is not None
+assert client.session() is not None
+```
+
+## Tests
+At the moment we use a pre-defined supabase instance to test the functionality. This may change over time. You can run the tests like so:
+```bash
+SUPABASE_TEST_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYW5vbiIsImlhdCI6MTYxMjYwOTMyMiwiZXhwIjoxOTI4MTg1MzIyfQ.XL9W5I_VRQ4iyQHVQmjG0BkwRfx6eVyYB3uAKcesukg" \
+SUPABASE_TEST_URL="https://tfsatoopsijgjhrqplra.supabase.co" \
+pytest -sx
+```
 
-### Development/TODOs
-- Figure out to use either Sessions to manage headers or allow passing in of headers
-- [] Add Documentation
+## Contributions
+We would be immensely grateful for any contributions to this project. In particular are the following items:
+- [x] Figure out to use either Sessions to manage headers or allow passing in of headers
+- [ ] Add documentation.
+- [ ] Add more tests.
+- [ ] Ensuring feature-parity with the js-client.
+- [ ] Supporting 3rd party provider authentication.
+- [ ] Implement a js port of setTimeout for the refresh session code.
 

gotrue/__init__.py

@@ -1,3 +1,6 @@
-__version__ = '0.1.0'
+__version__ = '0.2.0'
 
+from . import lib
+from . import api
+from . import client
 from .client import Client