Skip to main content

Supabase integration for pydantic

Project description

Supadantic

PyPI - Downloads GitHub License versions pypi

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.

Help

See documentation for more details.

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()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

supadantic-0.0.6.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

supadantic-0.0.6-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file supadantic-0.0.6.tar.gz.

File metadata

  • Download URL: supadantic-0.0.6.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.1 Linux/6.8.0-1021-azure

File hashes

Hashes for supadantic-0.0.6.tar.gz
Algorithm Hash digest
SHA256 55cb7427b6a3d0baf5fb724f11743dcb1e7bdf68d97e3d2845fbc60a7df8dd43
MD5 ec32d9487f586ff5e22910e6ef4883ee
BLAKE2b-256 bcd82102966b6745098a43cffd6ead65856550ae5b142cb0dc46b9aded88cbdb

See more details on using hashes here.

File details

Details for the file supadantic-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: supadantic-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.1 Linux/6.8.0-1021-azure

File hashes

Hashes for supadantic-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3136b5462c5c0037d3c356097d4960401e490c71874cfdac4f62fcba39f013bf
MD5 ed72e5a2b472e9a8688b2161256ba6db
BLAKE2b-256 a06e56676cd53550ec0630bb5d05def566c35fc3248c7840f4ff3829402b92b4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page