pydantic-converter

Convert pydantic models to other formats like typescript interfaces.

Installation

pip install pydantic-converter

Usage

You need to install json-schema-to-typescript to use this tool.

# sample.py
from pydantic_converter import schema
from pydantic import BaseModel


@schema
class User(BaseModel):
    name: str
    age: int

$ pydantic-converter --help
NAME
    pydantic-converter

SYNOPSIS
    pydantic-converter PATH OUTPUT_FILE <flags>

POSITIONAL ARGUMENTS
    PATH
        Type: str | pathlib.Path
    OUTPUT_FILE
        Type: str | pathlib.Path

FLAGS
    -r, --recursive=RECURSIVE  # Search .py files recursively from the given path.
        Type: bool
        Default: False
    -c, --camelize=CAMELIZE  # Convert field names to camelCase.
        Type: bool
        Default: False
    -e, --export_to=EXPORT_TO
        Type: Literal
        Default: 'ts'

$ pydantic-converter ./ ./output.ts

# output.ts
export Name = string;
export Age = number;
export interface User {
  name: Name;
  age: Age;
}

TODO

• Support other language formats