Skip to main content

A library to generate Pydantic models from SQLAlchemy models.

Project description

🐍🔗 SQLAlchemy-Pydantic Codegen

License PyPI Python Unit Tests

A Python library for generating Pydantic models from SQLAlchemy models, providing a seamless integration between SQLAlchemy and Pydantic for data validation and serialization.

✨ Key Features

  • Automatic Pydantic model generation from SQLAlchemy models.
  • Relationship support: Nested models for SQLAlchemy relationships.
  • Custom JSON/JSONB field mapping to your own Pydantic models.
  • Auto-generated __init__.py for schema packages.

📦 Installation

uv add sqlalchemy-pydantic-codegen

🚀 Usage

We recommend sqlacodegen to generate your SQLAlchemy models automatically.

Once your SQLAlchemy models are ready, generate Pydantic models with:

sqlalchemy-pydantic-codegen --models-path my_app.db.models --output-dir src/schemas
  • --models-path: Dotted path to your SQLAlchemy models (required)
  • --output-dir: Output directory for generated schemas (default: src/schemas)

🛠️ Custom Configuration

To map JSON/JSONB fields to custom Pydantic models, use the --config option.

Create a config file (e.g., codegen_config.py):

# codegen_config.py

# Maps table names to a dictionary of field names and the Pydantic model to use.
CUSTOM_JSONB_MODELS = {
    "my_table": {
        "my_jsonb_field": "MyCustomPydanticModelForJsonbField",
    },
}

# Maps the Pydantic model name to its full import statement.
CUSTOM_IMPORTS = {
    "MyCustomPydanticModelForJsonbField": "from my_app.schemas import MyCustomPydanticModelForJsonbField",
}

Then, run the command with the --config flag:

sqlalchemy-pydantic-codegen --models-path my_app.db.models --output-dir src/schemas --config codegen_config.py

📤 Output

  • One Pydantic schema file per SQLAlchemy model.
  • init.py with all exports and forward references.
  • Cleaned and ready-to-use Pydantic models.

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

sqlalchemy_pydantic_codegen-1.1.1.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

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

sqlalchemy_pydantic_codegen-1.1.1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file sqlalchemy_pydantic_codegen-1.1.1.tar.gz.

File metadata

File hashes

Hashes for sqlalchemy_pydantic_codegen-1.1.1.tar.gz
Algorithm Hash digest
SHA256 cc3d907b785899be50725cc2cf26817f235289fcc3b3a95427b57297fda4a599
MD5 7912e43b4533aca7d571c55571db062e
BLAKE2b-256 9c037a1a0866bf159a61a3fb956623c5586c10b1cdbd6695fa13acc3bab905dd

See more details on using hashes here.

File details

Details for the file sqlalchemy_pydantic_codegen-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sqlalchemy_pydantic_codegen-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c00b1d8b294bcba41433e0f17413fc35992aa98237e59af50a5808349b0ffb35
MD5 865bc6a366bfbea457c4366c4d13f901
BLAKE2b-256 794e80f672adeded98254796af5cc798042c11e59c6cd698b9f99f684fa64a83

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