Skip to main content

Supabase Pydantic Schemas

PyPI Version Conda Version Pydantic v2 GitHub License codecov PePy Downloads PyPI - Downloads

A project for generating Pydantic and SQLAlchemy models from Supabase and MySQL databases. This tool bridges the gap between your database schema and your Python code, providing type-safe models for FastAPI and other frameworks.

Currently, this is ideal for integrating FastAPI with supabase-py as a primary use-case. This project is inspired by the TS type generating capabilities of supabase cli. Its aim is to provide a similar experience for Python developers.

Project status (August 2026): maintenance mode. supabase-pydantic continues to receive bug fixes and dependency updates; nothing is being removed, and no end-of-life date has been set. New feature work has moved to castiron, its successor, which carries this project's schema-fidelity engine onto a source-agnostic architecture.

castiron is 0.1.0 and pre-alpha: today it reads the OpenAPI document a Supabase/PostgREST project publishes — no database connection, no driver — and emits Pydantic v2 models. It does not yet connect to a live database, emit SQLAlchemy models, read MySQL, or generate seed data, all of which supabase-pydantic does today. If you rely on those, stay here for now.

Install with pip install cast-iron (the distribution is hyphenated; the command and the import package are castiron). Docs · Repo · What this means for supabase-pydantic users

📣 NEW (Aug 2025): MySQL support! Generate models directly from MySQL databases with the --db-type mysql flag. See the docs

📣 NEW (Aug 2025): SQLAlchemy models with Insert and Update variants for better type safety. Learn more

Installation

# Install with pip
$ pip install supabase-pydantic

# Or with conda
$ conda install -c conda-forge supabase-pydantic

Configuration

Create a .env file with your database connection details:

DB_NAME=<your_db_name>
DB_USER=<your_db_user>
DB_PASS=<your_db_password>
DB_HOST=<your_db_host>
DB_PORT=<your_db_port>

Usage

Generate Pydantic Models

Example with full command output (using a local connection):

$ sb-pydantic gen --type pydantic --framework fastapi --local

2025-08-18 15:47:42 - INFO - supabase_pydantic.db.connection:check_connection:72 - PostGres connection is open.
2025-08-18 15:47:42 - INFO - supabase_pydantic.db.connection:construct_tables:136 - Processing schema: public
2025-08-18 15:47:42 - INFO - supabase_pydantic.db.connection:__exit__:105 - PostGres connection is closed.
2025-08-18 15:47:42 - INFO - supabase_pydantic.cli.commands.gen:gen:239 - Generating Pydantic models...
2025-08-18 15:47:42 - INFO - supabase_pydantic.cli.commands.gen:gen:251 - Pydantic models generated successfully for schema 'public': /path/to/your/project/entities/fastapi/schema_public_latest.py
2025-08-18 15:47:42 - INFO - supabase_pydantic.cli.commands.gen:gen:258 - File formatted successfully: /path/to/your/project/entities/fastapi/schema_public_latest.py

Common Commands

Using a database URL:

$ sb-pydantic gen --type pydantic --framework fastapi --db-url postgresql://postgres:postgres@127.0.0.1:54322/postgres

Generating models for specific schemas:

$ sb-pydantic gen --type pydantic --framework fastapi --local --schema extensions --schema auth

Generate SQLAlchemy models:

$ sb-pydantic gen --type sqlalchemy --local

Using MySQL:

$ sb-pydantic gen --type pydantic --framework fastapi --db-type mysql --db-url mysql://user:pass@localhost:3306/dbname

Makefile Integration

# Makefile examples for both Pydantic and SQLAlchemy generation

gen-pydantic:
    @echo "Generating FastAPI Pydantic models..."
    @sb-pydantic gen --type pydantic --framework fastapi --dir ./entities/fastapi --local

gen-sqlalchemy:
    @echo "Generating SQLAlchemy ORM models..."
    @sb-pydantic gen --type sqlalchemy --dir ./entities/sqlalchemy --local

# Generate all model types at once
gen-all: gen-pydantic gen-sqlalchemy
    @echo "All models generated successfully."

For full documentation, visit our docs site.

Download files

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

Source Distribution

supabase_pydantic-0.26.25.tar.gz (83.9 kB view details)

Uploaded Source

Built Distribution

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

supabase_pydantic-0.26.25-py3-none-any.whl (112.5 kB view details)

Uploaded Python 3

File details

Details for the file supabase_pydantic-0.26.25.tar.gz.

File metadata

  • Download URL: supabase_pydantic-0.26.25.tar.gz
  • Upload date:
  • Size: 83.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for supabase_pydantic-0.26.25.tar.gz
Algorithm Hash digest
SHA256 65f336a2aa6139e38888f31b8cc2b22eaba7cafc91189bd22a21b0474e10021c
MD5 e3416b9a47469386a318844388b7ca0f
BLAKE2b-256 4b84464c4bdb1a5961183a26bf0500484d8865762cab5a55e70b48ff04283407

See more details on using hashes here.

Provenance

The following attestation bundles were made for supabase_pydantic-0.26.25.tar.gz:

Publisher: python-publish.yml on kmbhm1/supabase-pydantic

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

File details

Details for the file supabase_pydantic-0.26.25-py3-none-any.whl.

File metadata

File hashes

Hashes for supabase_pydantic-0.26.25-py3-none-any.whl
Algorithm Hash digest
SHA256 6832dc500f59d3fcfabebb30779a4594f17a9e315df15ef01869f412694f7532
MD5 f3d4227369b5bd2085e09886450f28ed
BLAKE2b-256 f515af5216dbdc54b2b6d1de6304e7abad986b86ab0d87129b9a9e45ad906ef6

See more details on using hashes here.

Provenance

The following attestation bundles were made for supabase_pydantic-0.26.25-py3-none-any.whl:

Publisher: python-publish.yml on kmbhm1/supabase-pydantic

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

Release history Release notifications | RSS feed

This release

0.26.25 This release

2 files

0.26.24

2 files

0.26.23

2 files

0.26.22

2 files

0.26.21

2 files

0.26.20

2 files

0.26.19

2 files

0.26.18

2 files

0.26.17

2 files

0.26.16

2 files

0.26.15

2 files

0.26.14

2 files

0.26.13

2 files

0.26.12

2 files

0.26.11

2 files

0.26.10

2 files

0.26.9

2 files

0.26.8

2 files

0.26.7

2 files

0.26.6

2 files

0.26.5

2 files

0.26.4

2 files

0.26.3

2 files

0.26.2

2 files

0.26.1

2 files

0.26.0

2 files

0.25.7

2 files

0.25.6

2 files

0.25.5

2 files

0.25.4

2 files

0.25.3

2 files

0.25.2

2 files

0.25.1

2 files

0.25.0

2 files

0.24.2

2 files

0.24.1

2 files

0.24.0

2 files

0.23.0

2 files

0.22.3

2 files

0.22.2

2 files

0.22.1

2 files

0.22.0

2 files

0.21.0

2 files

0.20.0

2 files

0.19.8

2 files

0.19.7

2 files

0.19.6

2 files

0.19.5

2 files

0.19.4

2 files

0.18.3

2 files

0.18.2

2 files

0.18.1

2 files

0.18.0

2 files

0.17.4

2 files

0.17.3

2 files

0.17.2

2 files

0.17.1

2 files

0.17.0

2 files

0.16.0

2 files

0.15.6

2 files

0.15.5

2 files

0.15.4

2 files

0.15.3

2 files

0.15.2

2 files

0.15.1

2 files

0.15.0

2 files

0.14.6

2 files

0.14.5

2 files

0.14.4

2 files

0.14.3

2 files

0.14.2

2 files

0.14.1

2 files

0.14.0

2 files

0.13.1

2 files

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page