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.11.tar.gz (197.8 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.11-py3-none-any.whl (97.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_connector_models-0.1.11.tar.gz
Algorithm Hash digest
SHA256 539b72a446cc8893f084b4627ae7406d5952562c0032921e372d5e4dc196816f
MD5 0b2aa07764f78b29464a97502a42d736
BLAKE2b-256 a44c230437842995e10c15d4170f1c9ba31a63feb429b4c87ee1ebb926890dbf

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_connector_models-0.1.11.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.11-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_connector_models-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 c75a22138692bc90750ac3ad0bba403d2fb70f201eb4b59823d1354045e49339
MD5 8b42f3173e36996073daadbfcfc83db0
BLAKE2b-256 0996b76e789fda1120d38670a6f457261194bf6c693d7e3e19b78784d54f70fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_connector_models-0.1.11-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