# :electric_plug: Streamlit Supabase Connector
[](https://pepy.tech/project/st-supabase-connection)
A Streamlit connection component to connect Streamlit to Supabase Storage, Database, and Auth.
## :student: Interactive tutorial
[](https://st-supabase-connection.streamlit.app/)
## :thinking: Why use this?
- [X] Cache functionality to cache returned results. **Save time and money** on your API requests
- [X] Same method names as the Supabase Python API. **Minimum relearning required**
- [X] **Exposes more storage methods** than currently supported by the Supabase Python API. For example, `update()`, `create_signed_upload_url()`, and `upload_to_signed_url()`
- [X] **Less keystrokes required** when integrating with your Streamlit app.
<details close>
<summary>Examples with and without the connector </summary>
<br>
<table>
<tr>
<td><b>Without connector</b></td><td><b>With connector</b></td>
<tr>
<td colspan="2"> Download file to local system from Supabase storage </td>
<tr>
<td valign="top">
```python
import mimetypes
import streamlit as st
from supabase import create_client
supabase_client = create_client(
supabase_url="...", supabase_key="..."
)
bucket_id = st.text_input("Enter the bucket_id")
source_path = st.text_input("Enter source path")
file_name = source_path.split("/")[-1]
if st.button("Request download"):
with open(file_name, "wb+") as f:
response = supabase_client.storage.from_(
bucket_id
).download(source_path)
f.write(response)
mime = mimetypes.guess_type(file_name)[0]
data = open(file_name, "rb")
st.download_button(
"Download file", data=data,
file_name=file_name, mime=mime,
)
```
</td>
<td valign="top">
```python
import streamlit as st
from st_supabase_connection import SupabaseConnection
st_supabase_client = st.connection(
name="supabase_connection", type=SupabaseConnection
)
bucket_id = st.text_input("Enter the bucket_id")
source_path = st.text_input("Enter source path")
if st.button("Request download"):
file_name, mime, data = st_supabase_client.download(
bucket_id, source_path,
)
st.download_button(
"Download file", data=data,
file_name=file_name, mime=mime,
)
```
</td>
<tr>
<td colspan="2"> Upload file from local system to Supabase storage </td>
<tr>
<td valign="top">
```python
import streamlit as st
from supabase import create_client
supabase_client = create_client(
supabase_key="...", supabase_url="..."
)
bucket_id = st.text_input("Enter the bucket_id")
uploaded_file = st.file_uploader("Choose a file")
destination_path = st.text_input("Enter destination path")
overwrite = "true" if st.checkbox("Overwrite?") else "false"
with open(uploaded_file.name, "wb") as f:
f.write(uploaded_file.getbuffer())
if st.button("Upload"):
with open(uploaded_file.name, "rb") as f:
supabase_client.storage.from_(bucket_id).upload(
path=destination_path,
file=f,
file_options={
"content-type": uploaded_file.type,
"x-upsert": overwrite,
},
)
```
</td>
<td valign="top">
```python
import streamlit as st
from st_supabase_connection import SupabaseConnection
st_supabase_client = st.connection(
name="supabase_connection", type=SupabaseConnection
)
bucket_id = st.text_input("Enter the bucket_id")
uploaded_file = st.file_uploader("Choose a file"):
destination_path = st.text_input("Enter destination path")
overwrite = "true" if st.checkbox("Overwrite?") else "false"
if st.button("Upload"):
st_supabase_client.upload(
bucket_id, "local", uploaded_file,
destination_path, overwrite,
)
```
<tr>
</table>
</details>
## :hammer_and_wrench: Setup
1. Install `st-supabase-connection`
```sh
pip install st-supabase-connection
```
2. Set the `SUPABASE_URL` and `SUPABASE_KEY` Streamlit secrets as described [here](https://docs.streamlit.io/streamlit-community-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management).
> [!NOTE]
> For local development outside Streamlit, you can also set these as your environment variables (recommended), or pass these to the `url` and `key` args of `st.connection()`.
## :magic_wand: Usage
1. Import
```python
from st_supabase_connection import SupabaseConnection
```
2. Initialize
```python
st_supabase_client = st.connection(
name="YOUR_CONNECTION_NAME",
type=SupabaseConnection,
ttl=None,
url="YOUR_SUPABASE_URL", # not needed if provided as a streamlit secret
key="YOUR_SUPABASE_KEY", # not needed if provided as a streamlit secret
)
```
3. Use in your app to query tables and files. Happy Streamlit-ing! :balloon:
## :ok_hand: Supported methods
<details close>
<summary> Storage </summary>
<ul>
<li> <code>delete_bucket()</code> </li>
<li> <code>empty_bucket()</code> </li>
<li> <code>get_bucket()</code> </li>
<li> <code>list_buckets()</code> </li>
<li> <code>create_bucket()</code> </li>
<li> <code>upload()</code> </li>
<li> <code>download()</code> </li>
<li> <code>update_bucket()</code> </li>
<li> <code>move()</code> </li>
<li> <code>list_objects()</code> </li>
<li> <code>create_signed_urls()</code> </li>
<li> <code>get_public_url()</code> </li>
<li> <code>create_signed_upload_url()</code> </li>
<li> <code>upload_to_signed_url()</code> </li>
</ul>
</details>
<details close>
<summary> Database </summary>
<ul>
<li> <code>query()</code> - Runs a cached SELECT query </li>
<li> All methods supported by <a href="https://postgrest-py.readthedocs.io/en/latest/api/request_builders.html">postgrest-py</a>.
</details>
<details>
<summary> Auth </summary>
<ul>
All methods supported by <a href="https://supabase.com/docs/reference/python/auth-signup">Supabase's Python API </a>.
</details>
## :books: Examples
### :package: Storage operations
#### List existing buckets
```python
>>> st_supabase_client.list_buckets(ttl=None)
[
SyncBucket(
id="bucket1",
name="bucket1",
owner="",
public=False,
created_at=datetime.datetime(2023, 7, 31, 19, 56, 21, 518438, tzinfo=tzutc()),
updated_at=datetime.datetime(2023, 7, 31, 19, 56, 21, 518438, tzinfo=tzutc()),
file_size_limit=None,
allowed_mime_types=None,
),
SyncBucket(
id="bucket2",
name="bucket2",
owner="",
public=True,
created_at=datetime.datetime(2023, 7, 31, 19, 56, 28, 203536, tzinfo=tzutc()),
updated_at=datetime.datetime(2023, 7, 31, 19, 56, 28, 203536, tzinfo=tzutc()),
file_size_limit=100,
allowed_mime_types=["image/jpg", "image/png"],
),
]
```
#### Create a bucket
```python
>>> st_supabase_client.create_bucket("new_bucket")
{'name': 'new_bucket'}
```
#### Get bucket details
```python
>>> st_supabase_client.get_bucket("new_bucket")
SyncBucket(id='new_bucket', name='new_bucket', owner='', public=True, created_at=datetime.datetime(2023, 8, 2, 19, 41, 44, 810000, tzinfo=tzutc()), updated_at=datetime.datetime(2023, 8, 2, 19, 41, 44, 810000, tzinfo=tzutc()), file_size_limit=None, allowed_mime_types=None)
```
#### Update a bucket
```python
>>> st_supabase_client.update_bucket(
"new_bucket",
file_size_limit=100,
allowed_mime_types=["image/jpg", "image/png"],
public=True,
)
{'message': 'Successfully updated'}
```
#### Move files in a bucket
```python
>>> st_supabase_client.move("new_bucket", "test.png", "folder1/new_test.png")
{'message': 'Successfully moved'}
```
#### List objects in a bucket
```python
>>> st_supabase_client.list_objects("new_bucket", path="folder1", ttl=0)
[
{
"name": "new_test.png",
"id": "e506920e-2834-440e-85f1-1d5476927582",
"updated_at": "2023-08-02T19:53:22.53986+00:00",
"created_at": "2023-08-02T19:52:20.404391+00:00",
"last_accessed_at": "2023-08-02T19:53:21.833+00:00",
"metadata": {
"eTag": '"814a0034f5549e957ee61360d87457e5"',
"size": 473831,
"mimetype": "image/png",
"cacheControl": "max-age=3600",
"lastModified": "2023-08-02T19:53:23.000Z",
"contentLength": 473831,
"httpStatusCode": 200,
},
}
]
```
#### Empty a bucket
```python
>>> st_supabase_client.empty_bucket("new_bucket")
{'message': 'Successfully emptied'}
```
#### Delete a bucket
```python
>>> st_supabase_client.delete_bucket("new_bucket")
{'message': 'Successfully deleted'}
```
### :file_cabinet: Database operations
#### Simple query
```python
>>> st_supabase_client.query("*", table="countries", ttl=0).execute()
APIResponse(
data=[
{"id": 1, "name": "Afghanistan"},
{"id": 2, "name": "Albania"},
{"id": 3, "name": "Algeria"},
],
count=None,
)
```
#### Query with join
```python
>>> st_supabase_client.query("name, teams(name)", table="users", count="exact", ttl="1h").execute()
APIResponse(
data=[
{"name": "Kiran", "teams": [{"name": "Green"}, {"name": "Blue"}]},
{"name": "Evan", "teams": [{"name": "Blue"}]},
],
count=None,
)
```
#### Filter through foreign tables
```python
>>> st_supabase_client.query("name, countries(*)", count="exact", table="cities", ttl=None).eq(
"countries.name", "Curaçao"
).execute()
APIResponse(
data=[
{
"name": "Kralendijk",
"countries": {
"id": 2,
"name": "Curaçao",
"iso2": "CW",
"iso3": "CUW",
"local_name": None,
"continent": None,
},
},
{"name": "Willemstad", "countries": None},
],
count=2,
)
```
#### Insert rows
```python
>>> st_supabase_client.table("countries").insert(
[{"name": "Wakanda", "iso2": "WK"}, {"name": "Wadiya", "iso2": "WD"}], count="None"
).execute()
APIResponse(
data=[
{
"id": 250,
"name": "Wakanda",
"iso2": "WK",
"iso3": None,
"local_name": None,
"continent": None,
},
{
"id": 251,
"name": "Wadiya",
"iso2": "WD",
"iso3": None,
"local_name": None,
"continent": None,
},
],
count=None,
)
```
### :lock: Auth operations
> [!NOTE]
> If the call is valid, all Supabase Auth methods return the same response structure:
> ```json
> {
> "user": {
> "id": "e1f550fd-9cd1-44e4-bbe4-c04e91cf5544",
> "app_metadata": {
> "provider": "email",
> "providers": [
> "email"
> ]
> },
> "user_metadata": {
> "attribution": "I made it :)",
> "fname": "Siddhant"
> },
> "aud": "authenticated",
> "confirmation_sent_at": null,
> "recovery_sent_at": null,
> "email_change_sent_at": null,
> "new_email": null,
> "invited_at": null,
> "action_link": null,
> "email": "test.user@abc.com",
> "phone": "",
> "created_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 365359, tzinfo=datetime.timezone.utc)",
> "confirmed_at": null,
> "email_confirmed_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 373966, tzinfo=datetime.timezone.utc)",
> "phone_confirmed_at": null,
> "last_sign_in_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 377070, tzinfo=datetime.timezone.utc)",
> "role": "authenticated",
> "updated_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 381584, tzinfo=datetime.timezone.utc)",
> "identities": [
> {
> "id": "e1f550fd-9cd1-44e4-bbe4-c04e91cf5544",
> "user_id": "e1f550fd-9cd1-44e4-bbe4-c04e91cf5544",
> "identity_data": {
> "email": "siddhant.sadangi@gmail.com",
> "sub": "e1f550fd-9cd1-44e4-bbe4-c04e91cf5544"
> },
> "provider": "email",
> "created_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 370040, tzinfo=datetime.timezone.utc)",
> "last_sign_in_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 370002, tzinfo=datetime.timezone.utc)",
> "updated_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 370040, tzinfo=datetime.timezone.utc)"
> }
> ],
> "factors": null
> },
> "session": {
> "provider_token": null,
> "provider_refresh_token": null,
> "access_token": "***",
> "refresh_token": "***",
> "expires_in": 3600,
> "expires_at": 1696800390,
> "token_type": "bearer",
> "user": {
> "id": "e1f550fd-9cd1-44e4-bbe4-c04e91cf5544",
> "app_metadata": {
> "provider": "email",
> "providers": [
> "email"
> ]
> },
> "user_metadata": {
> "attribution": "I made it :)",
> "fname": "Siddhant"
> },
> "aud": "authenticated",
> "confirmation_sent_at": null,
> "recovery_sent_at": null,
> "email_change_sent_at": null,
> "new_email": null,
> "invited_at": null,
> "action_link": null,
> "email": "test.user@abc.com",
> "phone": "",
> "created_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 365359, tzinfo=datetime.timezone.utc)",
> "confirmed_at": null,
> "email_confirmed_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 373966, tzinfo=datetime.timezone.utc)",
> "phone_confirmed_at": null,
> "last_sign_in_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 377070, tzinfo=datetime.timezone.utc)",
> "role": "authenticated",
> "updated_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 381584, tzinfo=datetime.timezone.utc)",
> "identities": [
> {
> "id": "e1f550fd-9cd1-44e4-bbe4-c04e91cf5544",
> "user_id": "e1f550fd-9cd1-44e4-bbe4-c04e91cf5544",
> "identity_data": {
> "email": "siddhant.sadangi@gmail.com",
> "sub": "e1f550fd-9cd1-44e4-bbe4-c04e91cf5544"
> },
> "provider": "email",
> "created_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 370040, tzinfo=datetime.timezone.utc)",
> "last_sign_in_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 370002, tzinfo=datetime.timezone.utc)",
> "updated_at": "datetime.datetime(2023, 10, 8, 20, 26, 30, 370040, tzinfo=datetime.timezone.utc)"
> }
> ],
> "factors": null
> }
> }
> }
> ```
> </details>
#### Create new user
```python
>>> st_supabase_client.auth.sign_up(dict(email='test.user@abc.com', password='***', options=dict(data=dict(fname='Siddhant',attribution='I made it :)'))))
```
#### Sign in with password
```python
>>> st_supabase_client.auth.sign_in_with_password(dict(email='test.user@abc.com', password='***'))
```
#### Retrieve session
```python
>>> st_supabase.auth.get_session()
```
#### Retrieve user
```python
>>> st_supabase.auth.get_user()
```
#### Sign out
```python
>>> st_supabase.auth.sign_out()
```
> [!NOTE]
> Check the [Supabase Python API reference](https://supabase.com/docs/reference/python/select) for more examples.
## :star: Explore all options in a demo app
[](https://st-supabase-connection.streamlit.app/)
## :bow: Acknowledgements
This connector builds upon the awesome work done by the open-source community in general and the [Supabase Community](https://github.com/supabase-community) in particular. I cannot be more thankful to all the authors whose work I have used either directly or indirectly.
## :hugs: Want to support my work?
<p align="center">
<a href="https://www.buymeacoffee.com/siddhantsadangi" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;">
</a>
</p>
Raw data
{
"_id": null,
"home_page": "https://github.com/SiddhantSadangi/st_supabase_connection",
"name": "st-supabase-connection",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "streamlit,supabase,connection,integration",
"author": "Siddhant Sadangi",
"author_email": "siddhant.sadangi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6a/7c/bb6e5b7a521fbe264c0b22287adb0663747d5b4777fc285498ae27278673/st-supabase-connection-1.2.2.tar.gz",
"platform": null,
"description": "# :electric_plug: Streamlit Supabase Connector\n[](https://pepy.tech/project/st-supabase-connection)\n\nA Streamlit connection component to connect Streamlit to Supabase Storage, Database, and Auth.\n\n## :student: Interactive tutorial\n[](https://st-supabase-connection.streamlit.app/)\n\n\n\n## :thinking: Why use this?\n- [X] Cache functionality to cache returned results. **Save time and money** on your API requests\n- [X] Same method names as the Supabase Python API. **Minimum relearning required**\n- [X] **Exposes more storage methods** than currently supported by the Supabase Python API. For example, `update()`, `create_signed_upload_url()`, and `upload_to_signed_url()`\n- [X] **Less keystrokes required** when integrating with your Streamlit app.\n\n<details close>\n<summary>Examples with and without the connector </summary>\n<br>\n<table>\n<tr>\n<td><b>Without connector</b></td><td><b>With connector</b></td>\n<tr>\n<td colspan=\"2\"> Download file to local system from Supabase storage </td>\n<tr>\n<td valign=\"top\">\n\n```python\nimport mimetypes\nimport streamlit as st\nfrom supabase import create_client\n\nsupabase_client = create_client(\n supabase_url=\"...\", supabase_key=\"...\"\n)\n\nbucket_id = st.text_input(\"Enter the bucket_id\")\nsource_path = st.text_input(\"Enter source path\")\n\nfile_name = source_path.split(\"/\")[-1]\n\nif st.button(\"Request download\"):\n with open(file_name, \"wb+\") as f:\n response = supabase_client.storage.from_(\n bucket_id\n ).download(source_path)\n f.write(response)\n\n mime = mimetypes.guess_type(file_name)[0]\n data = open(file_name, \"rb\")\n\n st.download_button(\n \"Download file\", data=data, \n file_name=file_name, mime=mime,\n )\n```\n\n</td>\n<td valign=\"top\">\n\n```python\nimport streamlit as st\nfrom st_supabase_connection import SupabaseConnection\n\nst_supabase_client = st.connection(\n name=\"supabase_connection\", type=SupabaseConnection\n)\n\nbucket_id = st.text_input(\"Enter the bucket_id\")\nsource_path = st.text_input(\"Enter source path\")\n\nif st.button(\"Request download\"):\n file_name, mime, data = st_supabase_client.download(\n bucket_id, source_path,\n )\n\n st.download_button(\n \"Download file\", data=data, \n file_name=file_name, mime=mime,\n )\n\n```\n\n</td>\n<tr>\n<td colspan=\"2\"> Upload file from local system to Supabase storage </td>\n<tr>\n<td valign=\"top\">\n\n```python\nimport streamlit as st\nfrom supabase import create_client\n\nsupabase_client = create_client(\nsupabase_key=\"...\", supabase_url=\"...\"\n)\n\nbucket_id = st.text_input(\"Enter the bucket_id\")\nuploaded_file = st.file_uploader(\"Choose a file\")\ndestination_path = st.text_input(\"Enter destination path\")\noverwrite = \"true\" if st.checkbox(\"Overwrite?\") else \"false\" \n\nwith open(uploaded_file.name, \"wb\") as f:\n f.write(uploaded_file.getbuffer())\n\nif st.button(\"Upload\"):\n with open(uploaded_file.name, \"rb\") as f:\n supabase_client.storage.from_(bucket_id).upload(\n path=destination_path,\n file=f,\n file_options={\n \"content-type\": uploaded_file.type,\n \"x-upsert\": overwrite,\n },\n )\n\n``` \n\n</td>\n<td valign=\"top\">\n\n```python\nimport streamlit as st\nfrom st_supabase_connection import SupabaseConnection\n\nst_supabase_client = st.connection(\n name=\"supabase_connection\", type=SupabaseConnection\n)\n\nbucket_id = st.text_input(\"Enter the bucket_id\")\nuploaded_file = st.file_uploader(\"Choose a file\"):\ndestination_path = st.text_input(\"Enter destination path\")\noverwrite = \"true\" if st.checkbox(\"Overwrite?\") else \"false\" \n\nif st.button(\"Upload\"):\n st_supabase_client.upload(\n bucket_id, \"local\", uploaded_file, \n destination_path, overwrite,\n )\n```\n<tr>\n</table>\n\n</details>\n\n## :hammer_and_wrench: Setup\n\n1. Install `st-supabase-connection`\n```sh\npip install st-supabase-connection\n```\n2. Set the `SUPABASE_URL` and `SUPABASE_KEY` Streamlit secrets as described [here](https://docs.streamlit.io/streamlit-community-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management).\n\n> [!NOTE] \n> For local development outside Streamlit, you can also set these as your environment variables (recommended), or pass these to the `url` and `key` args of `st.connection()`.\n\n## :magic_wand: Usage\n\n1. Import\n ```python\n from st_supabase_connection import SupabaseConnection\n ```\n2. Initialize\n ```python\n st_supabase_client = st.connection(\n name=\"YOUR_CONNECTION_NAME\",\n type=SupabaseConnection,\n ttl=None,\n url=\"YOUR_SUPABASE_URL\", # not needed if provided as a streamlit secret\n key=\"YOUR_SUPABASE_KEY\", # not needed if provided as a streamlit secret\n )\n ```\n3. Use in your app to query tables and files. Happy Streamlit-ing! :balloon:\n\n## :ok_hand: Supported methods\n<details close>\n<summary> Storage </summary>\n<ul>\n <li> <code>delete_bucket()</code> </li>\n <li> <code>empty_bucket()</code> </li>\n <li> <code>get_bucket()</code> </li>\n <li> <code>list_buckets()</code> </li>\n <li> <code>create_bucket()</code> </li>\n <li> <code>upload()</code> </li>\n <li> <code>download()</code> </li>\n <li> <code>update_bucket()</code> </li>\n <li> <code>move()</code> </li>\n <li> <code>list_objects()</code> </li>\n <li> <code>create_signed_urls()</code> </li>\n <li> <code>get_public_url()</code> </li>\n <li> <code>create_signed_upload_url()</code> </li>\n <li> <code>upload_to_signed_url()</code> </li>\n</ul> \n\n</details>\n\n<details close>\n<summary> Database </summary>\n<ul>\n <li> <code>query()</code> - Runs a cached SELECT query </li>\n <li> All methods supported by <a href=\"https://postgrest-py.readthedocs.io/en/latest/api/request_builders.html\">postgrest-py</a>.\n</details>\n\n<details>\n<summary> Auth </summary>\n<ul>\n All methods supported by <a href=\"https://supabase.com/docs/reference/python/auth-signup\">Supabase's Python API </a>.\n</details>\n\n## :books: Examples\n### :package: Storage operations\n\n#### List existing buckets\n```python\n>>> st_supabase_client.list_buckets(ttl=None)\n[\n SyncBucket(\n id=\"bucket1\",\n name=\"bucket1\",\n owner=\"\",\n public=False,\n created_at=datetime.datetime(2023, 7, 31, 19, 56, 21, 518438, tzinfo=tzutc()),\n updated_at=datetime.datetime(2023, 7, 31, 19, 56, 21, 518438, tzinfo=tzutc()),\n file_size_limit=None,\n allowed_mime_types=None,\n ),\n SyncBucket(\n id=\"bucket2\",\n name=\"bucket2\",\n owner=\"\",\n public=True,\n created_at=datetime.datetime(2023, 7, 31, 19, 56, 28, 203536, tzinfo=tzutc()),\n updated_at=datetime.datetime(2023, 7, 31, 19, 56, 28, 203536, tzinfo=tzutc()),\n file_size_limit=100,\n allowed_mime_types=[\"image/jpg\", \"image/png\"],\n ),\n]\n```\n#### Create a bucket\n```python\n>>> st_supabase_client.create_bucket(\"new_bucket\")\n{'name': 'new_bucket'}\n```\n\n#### Get bucket details\n```python\n>>> st_supabase_client.get_bucket(\"new_bucket\")\nSyncBucket(id='new_bucket', name='new_bucket', owner='', public=True, created_at=datetime.datetime(2023, 8, 2, 19, 41, 44, 810000, tzinfo=tzutc()), updated_at=datetime.datetime(2023, 8, 2, 19, 41, 44, 810000, tzinfo=tzutc()), file_size_limit=None, allowed_mime_types=None)\n```\n#### Update a bucket\n```python\n>>> st_supabase_client.update_bucket(\n \"new_bucket\",\n file_size_limit=100,\n allowed_mime_types=[\"image/jpg\", \"image/png\"],\n public=True,\n )\n{'message': 'Successfully updated'}\n```\n\n#### Move files in a bucket\n```python\n>>> st_supabase_client.move(\"new_bucket\", \"test.png\", \"folder1/new_test.png\")\n{'message': 'Successfully moved'}\n```\n\n#### List objects in a bucket\n```python\n>>> st_supabase_client.list_objects(\"new_bucket\", path=\"folder1\", ttl=0)\n[\n {\n \"name\": \"new_test.png\",\n \"id\": \"e506920e-2834-440e-85f1-1d5476927582\",\n \"updated_at\": \"2023-08-02T19:53:22.53986+00:00\",\n \"created_at\": \"2023-08-02T19:52:20.404391+00:00\",\n \"last_accessed_at\": \"2023-08-02T19:53:21.833+00:00\",\n \"metadata\": {\n \"eTag\": '\"814a0034f5549e957ee61360d87457e5\"',\n \"size\": 473831,\n \"mimetype\": \"image/png\",\n \"cacheControl\": \"max-age=3600\",\n \"lastModified\": \"2023-08-02T19:53:23.000Z\",\n \"contentLength\": 473831,\n \"httpStatusCode\": 200,\n },\n }\n]\n```\n\n#### Empty a bucket\n```python\n>>> st_supabase_client.empty_bucket(\"new_bucket\")\n{'message': 'Successfully emptied'}\n```\n#### Delete a bucket\n```python\n>>> st_supabase_client.delete_bucket(\"new_bucket\")\n{'message': 'Successfully deleted'}\n```\n### :file_cabinet: Database operations\n#### Simple query \n```python\n>>> st_supabase_client.query(\"*\", table=\"countries\", ttl=0).execute()\nAPIResponse(\n data=[\n {\"id\": 1, \"name\": \"Afghanistan\"},\n {\"id\": 2, \"name\": \"Albania\"},\n {\"id\": 3, \"name\": \"Algeria\"},\n ],\n count=None,\n)\n```\n#### Query with join\n```python\n>>> st_supabase_client.query(\"name, teams(name)\", table=\"users\", count=\"exact\", ttl=\"1h\").execute()\nAPIResponse(\n data=[\n {\"name\": \"Kiran\", \"teams\": [{\"name\": \"Green\"}, {\"name\": \"Blue\"}]},\n {\"name\": \"Evan\", \"teams\": [{\"name\": \"Blue\"}]},\n ],\n count=None,\n)\n```\n#### Filter through foreign tables\n```python\n>>> st_supabase_client.query(\"name, countries(*)\", count=\"exact\", table=\"cities\", ttl=None).eq(\n \"countries.name\", \"Cura\u00e7ao\"\n ).execute()\n\nAPIResponse(\n data=[\n {\n \"name\": \"Kralendijk\",\n \"countries\": {\n \"id\": 2,\n \"name\": \"Cura\u00e7ao\",\n \"iso2\": \"CW\",\n \"iso3\": \"CUW\",\n \"local_name\": None,\n \"continent\": None,\n },\n },\n {\"name\": \"Willemstad\", \"countries\": None},\n ],\n count=2,\n)\n```\n\n#### Insert rows\n```python\n>>> st_supabase_client.table(\"countries\").insert(\n [{\"name\": \"Wakanda\", \"iso2\": \"WK\"}, {\"name\": \"Wadiya\", \"iso2\": \"WD\"}], count=\"None\"\n ).execute()\nAPIResponse(\n data=[\n {\n \"id\": 250,\n \"name\": \"Wakanda\",\n \"iso2\": \"WK\",\n \"iso3\": None,\n \"local_name\": None,\n \"continent\": None,\n },\n {\n \"id\": 251,\n \"name\": \"Wadiya\",\n \"iso2\": \"WD\",\n \"iso3\": None,\n \"local_name\": None,\n \"continent\": None,\n },\n ],\n count=None,\n)\n```\n\n### :lock: Auth operations\n\n> [!NOTE] \n> If the call is valid, all Supabase Auth methods return the same response structure:\n> ```json\n> {\n> \"user\": {\n> \"id\": \"e1f550fd-9cd1-44e4-bbe4-c04e91cf5544\",\n> \"app_metadata\": {\n> \"provider\": \"email\",\n> \"providers\": [\n> \"email\"\n> ]\n> },\n> \"user_metadata\": {\n> \"attribution\": \"I made it :)\",\n> \"fname\": \"Siddhant\"\n> },\n> \"aud\": \"authenticated\",\n> \"confirmation_sent_at\": null,\n> \"recovery_sent_at\": null,\n> \"email_change_sent_at\": null,\n> \"new_email\": null,\n> \"invited_at\": null,\n> \"action_link\": null,\n> \"email\": \"test.user@abc.com\",\n> \"phone\": \"\",\n> \"created_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 365359, tzinfo=datetime.timezone.utc)\",\n> \"confirmed_at\": null,\n> \"email_confirmed_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 373966, tzinfo=datetime.timezone.utc)\",\n> \"phone_confirmed_at\": null,\n> \"last_sign_in_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 377070, tzinfo=datetime.timezone.utc)\",\n> \"role\": \"authenticated\",\n> \"updated_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 381584, tzinfo=datetime.timezone.utc)\",\n> \"identities\": [\n> {\n> \"id\": \"e1f550fd-9cd1-44e4-bbe4-c04e91cf5544\",\n> \"user_id\": \"e1f550fd-9cd1-44e4-bbe4-c04e91cf5544\",\n> \"identity_data\": {\n> \"email\": \"siddhant.sadangi@gmail.com\",\n> \"sub\": \"e1f550fd-9cd1-44e4-bbe4-c04e91cf5544\"\n> },\n> \"provider\": \"email\",\n> \"created_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 370040, tzinfo=datetime.timezone.utc)\",\n> \"last_sign_in_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 370002, tzinfo=datetime.timezone.utc)\",\n> \"updated_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 370040, tzinfo=datetime.timezone.utc)\"\n> }\n> ],\n> \"factors\": null\n> },\n> \"session\": {\n> \"provider_token\": null,\n> \"provider_refresh_token\": null,\n> \"access_token\": \"***\",\n> \"refresh_token\": \"***\",\n> \"expires_in\": 3600,\n> \"expires_at\": 1696800390,\n> \"token_type\": \"bearer\",\n> \"user\": {\n> \"id\": \"e1f550fd-9cd1-44e4-bbe4-c04e91cf5544\",\n> \"app_metadata\": {\n> \"provider\": \"email\",\n> \"providers\": [\n> \"email\"\n> ]\n> },\n> \"user_metadata\": {\n> \"attribution\": \"I made it :)\",\n> \"fname\": \"Siddhant\"\n> },\n> \"aud\": \"authenticated\",\n> \"confirmation_sent_at\": null,\n> \"recovery_sent_at\": null,\n> \"email_change_sent_at\": null,\n> \"new_email\": null,\n> \"invited_at\": null,\n> \"action_link\": null,\n> \"email\": \"test.user@abc.com\",\n> \"phone\": \"\",\n> \"created_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 365359, tzinfo=datetime.timezone.utc)\",\n> \"confirmed_at\": null,\n> \"email_confirmed_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 373966, tzinfo=datetime.timezone.utc)\",\n> \"phone_confirmed_at\": null,\n> \"last_sign_in_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 377070, tzinfo=datetime.timezone.utc)\",\n> \"role\": \"authenticated\",\n> \"updated_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 381584, tzinfo=datetime.timezone.utc)\",\n> \"identities\": [\n> {\n> \"id\": \"e1f550fd-9cd1-44e4-bbe4-c04e91cf5544\",\n> \"user_id\": \"e1f550fd-9cd1-44e4-bbe4-c04e91cf5544\",\n> \"identity_data\": {\n> \"email\": \"siddhant.sadangi@gmail.com\",\n> \"sub\": \"e1f550fd-9cd1-44e4-bbe4-c04e91cf5544\"\n> },\n> \"provider\": \"email\",\n> \"created_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 370040, tzinfo=datetime.timezone.utc)\",\n> \"last_sign_in_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 370002, tzinfo=datetime.timezone.utc)\",\n> \"updated_at\": \"datetime.datetime(2023, 10, 8, 20, 26, 30, 370040, tzinfo=datetime.timezone.utc)\"\n> }\n> ],\n> \"factors\": null\n> }\n> }\n> }\n> ```\n> </details>\n\n#### Create new user\n```python\n>>> st_supabase_client.auth.sign_up(dict(email='test.user@abc.com', password='***', options=dict(data=dict(fname='Siddhant',attribution='I made it :)'))))\n```\n\n#### Sign in with password\n```python\n>>> st_supabase_client.auth.sign_in_with_password(dict(email='test.user@abc.com', password='***'))\n```\n\n#### Retrieve session\n```python\n>>> st_supabase.auth.get_session()\n```\n\n#### Retrieve user\n```python\n>>> st_supabase.auth.get_user()\n```\n\n#### Sign out\n```python\n>>> st_supabase.auth.sign_out()\n```\n\n> [!NOTE] \n> Check the [Supabase Python API reference](https://supabase.com/docs/reference/python/select) for more examples.\n\n## :star: Explore all options in a demo app\n[](https://st-supabase-connection.streamlit.app/)\n\n## :bow: Acknowledgements\nThis connector builds upon the awesome work done by the open-source community in general and the [Supabase Community](https://github.com/supabase-community) in particular. I cannot be more thankful to all the authors whose work I have used either directly or indirectly.\n\n## :hugs: Want to support my work?\n<p align=\"center\">\n <a href=\"https://www.buymeacoffee.com/siddhantsadangi\" target=\"_blank\"><img src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\">\n </a>\n</p>\n",
"bugtrack_url": null,
"license": "",
"summary": "A Streamlit connection component for Supabase.",
"version": "1.2.2",
"project_urls": {
"Documentation": "https://github.com/SiddhantSadangi/st_supabase_connection/blob/main/README.md",
"Funding": "https://www.buymeacoffee.com/siddhantsadangi",
"Homepage": "https://github.com/SiddhantSadangi/st_supabase_connection"
},
"split_keywords": [
"streamlit",
"supabase",
"connection",
"integration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "874aa50896b02bf51c06ae8c42e76e1e90969fb02607e6a5acafa750749c456d",
"md5": "660d1e62ef84f7aeddb84c8c4f8a0f47",
"sha256": "7a2d3ea32f69c2160315d52b7c0017a213772cdccc357b1f4020db468d5e4324"
},
"downloads": -1,
"filename": "st_supabase_connection-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "660d1e62ef84f7aeddb84c8c4f8a0f47",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10710,
"upload_time": "2023-12-09T15:45:46",
"upload_time_iso_8601": "2023-12-09T15:45:46.602425Z",
"url": "https://files.pythonhosted.org/packages/87/4a/a50896b02bf51c06ae8c42e76e1e90969fb02607e6a5acafa750749c456d/st_supabase_connection-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6a7cbb6e5b7a521fbe264c0b22287adb0663747d5b4777fc285498ae27278673",
"md5": "798f39bdd431280c257c4e1b2b0884e7",
"sha256": "3e6508f96cb7edba69b06b80d65086bedc4baeac989780405556ca4b32862053"
},
"downloads": -1,
"filename": "st-supabase-connection-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "798f39bdd431280c257c4e1b2b0884e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15023,
"upload_time": "2023-12-09T15:45:48",
"upload_time_iso_8601": "2023-12-09T15:45:48.323375Z",
"url": "https://files.pythonhosted.org/packages/6a/7c/bb6e5b7a521fbe264c0b22287adb0663747d5b4777fc285498ae27278673/st-supabase-connection-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 15:45:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SiddhantSadangi",
"github_project": "st_supabase_connection",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "st-supabase-connection"
}
JSON
