You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-15Lines changed: 29 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -9,25 +9,32 @@ Supabase client for Python. This mirrors the design of [supabase-js](https://git
9
9
**Recomended:** First activate your virtual environment, with your favourites system. For example, we like `poetry` and `conda`!
10
10
11
11
#### PyPi installation
12
+
12
13
Now install the package.
14
+
13
15
```bash
14
16
pip install supabase
15
17
```
16
18
17
19
#### Local installation
20
+
18
21
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.
19
-
```bash
22
+
23
+
```bash
20
24
pip install -e .
21
25
```
22
26
23
27
## Usage
28
+
24
29
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.
We can then read the keys in the python source code.
37
+
31
38
```python
32
39
import os
33
40
from supabase_py import create_client, Client
@@ -41,58 +48,63 @@ user = supabase.auth.sign_up(email, password)
41
48
```
42
49
43
50
### Running Tests
51
+
44
52
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:
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
58
+
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
0 commit comments