Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.

Commit 1ab2974

Browse files
author
Joel Lee
committed
chore: add usage instructions
1 parent 7c754cf commit 1ab2974

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
11
# Storage-py
22

33
Python Client library to interact with Supabase Storage.
4+
5+
6+
7+
## How to use
8+
9+
As it takes some effort to get the headers. We suggest that you use the storage functionality through the main [Supabase Python Client](https://github.com/supabase-community/supabase-py)
10+
11+
12+
```python3
13+
from storage3 import storage_client
14+
15+
storage_client = storage_client.SupabaseStorageClient('https://<your_supabase_id>.supabase.co/storage/v1)', {'apiKey': '<your_api_key>', 'Authorization': 'Bearer <an_auth_token>'})
16+
17+
storage_client.list()
18+
```

storage3/storage_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ class SupabaseStorageClient(StorageBucketAPI):
1919
def __init__(self, url: str, headers: Dict[str, str]):
2020
super().__init__(url, headers)
2121

22-
def StorageFileAPI(self, id_: str) -> StorageFileAPI:
22+
def from_(self, id_: str) -> StorageFileAPI:
2323
return StorageFileAPI(self.url, self.headers, id_)

0 commit comments

Comments
 (0)