supercargo 0.3.0

Native Python annotations for Supercargo type-safe metadata

Supercargo Python SDK

Native Python annotations for Supercargo type-safe metadata.

Installation

pip install supercargo

Usage

Use the Supercargo class within Python's typing.Annotated (or Pydantic models) to attach metadata to your data models. This metadata is statically extracted by the sc CLI.

from typing import Annotated
from datetime import datetime
from pydantic import BaseModel
from supercargo import Supercargo

class PlaybackSession(BaseModel):
    # Attach entity mapping
    user_id: Annotated[str, Supercargo(entity="user")]

    # Provide a type hint for the schema generator
    started_at: Annotated[datetime, Supercargo(as_type="TIMESTAMP")]