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.9.tar.gz (13.5 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.9-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: supadantic-0.0.9.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for supadantic-0.0.9.tar.gz
Algorithm Hash digest
SHA256 b8e7f7fe638e6420cd3cd814c0a710b5f3ee3c84ea28c210f6b1e1a134d1ef3c
MD5 cc25205a9bec5166233d030216402a09
BLAKE2b-256 0cabf6d66fe0837e2b3695cf3abc96eb2663cf14c5c94b5704dc9228a17a6509

See more details on using hashes here.

Provenance

The following attestation bundles were made for supadantic-0.0.9.tar.gz:

Publisher: release.yml on makridenko/supadantic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: supadantic-0.0.9-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for supadantic-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f5f7839640e3ccba6313aeb0ff9797cfd342524ebc4444d951a9d033e1b6f078
MD5 0d71111c316e7942ea168397a1f5593e
BLAKE2b-256 a89b1df7a3e1daf29bcb949501e0c00cd73eb633a30cfbf779d86f14c7ef0257

See more details on using hashes here.

Provenance

The following attestation bundles were made for supadantic-0.0.9-py3-none-any.whl:

Publisher: release.yml on makridenko/supadantic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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