makridenko / supadantic

Pydantic + Supabase = <3

Supadantic

Supadantic is a small Python library that allows you to manage Supabase tables through Pydantic models. It is very convenient to use in projects based on FastAPI, Flask, and so on.

Important information

Supadantic may not have backward compatibility until version 0.1.0. This is because the library is still experimental and is being used in several of my other projects, where requirements are still being finalized.

Installation

Install using pip install -U supadantic.

Also, you need to add SUPABASE_URL and SUPABASE_KEY to your env variables.

A Simple example

from supadantic.models import BaseSBModel


class User(BaseSBModel):
    # id field already defined in BaseSBModel class
    name: str = 'John Doe'
    is_active: bool = True

    # By default table name is class name in snake_case
    # If you want to change it - you should implement _get_table_name method
    @classmethod
    def _get_table_name(cls) -> str:
        return 'db_user'

# Save user
active_user = User(name='John Snow')
active_user.save()

non_active_user = User(is_active=False)
non_active_user.save()

# Get all users
users = User.objects.all()

# Count users
users.count()

# Get first user
users.first()

# Get last user
users.last()

# Filter users
active_users = User.objects.filter(is_active=True)
# Or
active_users = User.objects.exclude(is_active=False)

# Update all active users
active_users.update(is_active=False)

# Delete all non active users
User.objects.exclude(is_active=True).delete()

# Get one user and delete
user = User.objects.get(name='John Doe')
user.delete()

supadantic's Issues

Documentation

1. Idea is to use sphinx + readthedocs. Need to add docs generation to CI/CD
2. there is an error in README.md (supabase link)

Release 0.0.5

Fix `.objects` typing

Fix workflows

Related objects support

Need to describe.

class User(BaseDBEntity):
    pass

class UserSettings(BaseDBEntity):
    user = User()

user = User()
user_settings = UserSettings(user=user)

Type `List[str]` not working properly

class User(BaseSBModel):
    some_field = List[str]

user = User(some_field=['foo', 'bar'])
user.save() # Error (supabase SDK returns "['foo', 'bar']")

Optimize supabase queries by sending a single request at the end of `QSet` formation

# This hits supabase 3 times, need 1 
User.filter(eq={'name': 'name'}).filter(eq={'age': 21}).filter(eq={'is_active': True})

Add `BaseClient` abstract class

`delete` method

user = User()
user.save()
user.delete()

Get `table_name` from class name

By default - table_name == lower class name in snake case

`QSet` object

QSet object will store supadantic entities.
It should have two methods:

• delete - delete all objects in QSet
• update - (deprecate bulk_update) - update all objects in QSet

users = User.get_list()
users.update(data={'name': 'John Doe'})
users.delete()

Add more useful filters

# Old filters
User.objects.filter(eq={'name': 'test'}, neq={'id': 1})

# New filters
User.objects.filter(name='test').exclude(id=1)

Add `get_or_create` method to `QSet`

Add `CacheClientClass` for saving values in cache (for testing and debugging)

Remove `develop` branch and change workflows

Remove `QSet` methods from `BaseSBModel`

It should be more like django orm-style

User.objects.all()
User.objects.filter()
User.objects.exclude()
User.objects.update()
User.objects.delete()