Metadata-Version: 2.4
Name: supercargo
Version: 0.3.0
Summary: Native Python annotations for Supercargo type-safe metadata
Author: Supercargo
Author-email: support@supercargo.dev
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Project-URL: Homepage, https://supercargo.dev
Description-Content-Type: text/markdown

# Supercargo Python SDK

Native Python annotations for Supercargo type-safe metadata.

## Installation

```bash
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.

```python
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")]
```

