Skip to main content

Airbyte Connector Models

Typed Pydantic models for Airbyte connectors, providing type-safe configuration and record handling.

Overview

This package provides automatically generated Pydantic models for:

  • Config Models: Type-safe configuration for all Airbyte connectors
  • Record Models: Typed records for all source connector streams
  • Metadata Models: Models used in metadata.yaml files
  • Registry Models: Modules used by the Airbyte Connector Registry

Models are generated nightly from the latest connector specifications and schemas.

Installation

pip install airbyte-connector-models

Usage

Config Models

from airbyte_connector_models.connectors.postgres.source.config import SourcePostgresConfigSpec
import airbyte as ab  # Optional import if using with PyAirbyte

# Type-safe config
config = SourcePostgresConfigSpec(
    host="localhost",
    port=5432,
    database="mydb",
    username="user",
    password="pass"
)

# Use with PyAirbyte (optional)
source = ab.get_source("source-postgres", config=config)

Record Models

Note: Below is planned functionality (not yet available).

from airbyte_connector_models.connectors.postgres.source.records import PostgresUsersRecord
import airbyte as ab

source = ab.get_source("source-postgres", config=config)
source.select_streams(["users"])

# Get typed records
for record in source.get_records("users", as_model=PostgresUsersRecord):
    print(f"User: {record.name}, Email: {record.email}")
    # Access extra properties ergonomically
    if hasattr(record, "custom_field"):
        print(f"Custom: {record.custom_field}")

Features

  • Type Safety: Full type hints for IDE autocomplete and type checking
  • Additional Properties: Ergonomic access to extra fields not in the schema
  • Minimal Normalization: Field names preserve original casing, only illegal characters are replaced
  • Validation: Automatic validation of configs and records using Pydantic
  • Nightly Updates: Models are regenerated nightly to stay in sync with connector changes

Structure

airbyte_connector_models/
├── connectors/
│   ├── github/
│   │   ├── source/
│   │   │   ├── configuration.py      # SourceGitHubConficSpec
│   │   │   ├── configuration.json    # JSON Schema Spec
│   │   │   └── records/              # Module containing record model specifications
│   │   └── destination/
│   │   │   ├── configuration.py      # DestinationGitHubConficSpec
│   │   │   ├── configuration.json    # JSON Schema Spec
│   └── ...

Contributing

See the Contributing Guide

Download files

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

Source Distribution

airbyte_connector_models-0.1.8.tar.gz (189.3 kB view details)

Uploaded Source

Built Distribution

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

airbyte_connector_models-0.1.8-py3-none-any.whl (92.9 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_connector_models-0.1.8.tar.gz.

File metadata

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

File hashes

Hashes for airbyte_connector_models-0.1.8.tar.gz
Algorithm Hash digest
SHA256 dccc08b547e9d2c7d9b7ca52b20929fc6e6f52c71bb3a671d0499724fbc0ea84
MD5 6b11bafcd697c564f2ce38f845d6288e
BLAKE2b-256 5ec9e57a66122e370541e462b21f937680c8de6455e7afb856b06bedd17c946d

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_connector_models-0.1.8.tar.gz:

Publisher: publish.yml on airbytehq/airbyte-connector-models

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

File details

Details for the file airbyte_connector_models-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_connector_models-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7be82ca5d91832026fd229e050d2e9800cf5bd4ff7313a1502605b629bf83814
MD5 8506e67451251df9a5ca8a13a07e6e7e
BLAKE2b-256 70f7b88bd5f8d42e00c15b01d0559d4e0974538b80ae6c197eff855398ba5e66

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_connector_models-0.1.8-py3-none-any.whl:

Publisher: publish.yml on airbytehq/airbyte-connector-models

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page