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.8.tar.gz (13.2 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.8-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: supadantic-0.0.8.tar.gz
  • Upload date:
  • Size: 13.2 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.8.tar.gz
Algorithm Hash digest
SHA256 297a972ddb1655d292d4665b306ad632e328e88b2d1c409363c480bf2ea6b3cd
MD5 dd64cf0e40d853d7bbfa4673bbac1272
BLAKE2b-256 8ce8528faaaa373b3bb0bc28c0d434f7c48984eb612113659fa2b2bea0506cdd

See more details on using hashes here.

Provenance

The following attestation bundles were made for supadantic-0.0.8.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.8-py3-none-any.whl.

File metadata

  • Download URL: supadantic-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 16.2 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 f4004b191423d638a8de6d5c566af110a66d8366fa629c8c1bdd974ad51659e0
MD5 ff3fb4ee33b93b8f40b8d3f3cf711527
BLAKE2b-256 ff7739a9b568381957cd751d70cea82e01dbb61de0e6a0c065567911dd3a39bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for supadantic-0.0.8-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