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.10.tar.gz (193.1 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.10-py3-none-any.whl (95.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_connector_models-0.1.10.tar.gz
Algorithm Hash digest
SHA256 07fe6177cee5d06e6c90f009624551f2870e17a576168331a7bcbfdb320bf18a
MD5 83aeac679039a4d2a17e73aeabce1fe7
BLAKE2b-256 43329d89da3fe3030b5cde0d025245996c770a87722da8653402c6238a32c402

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for airbyte_connector_models-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 6660c0d05a1f2d7db1e1917ef65ed96d31e944bd2bdab01872d745bdd48e25ef
MD5 9ac0af13a8765d1f692246a37f6110ad
BLAKE2b-256 fecf81192bb577bb8cea4d0e353b786168186069ac3913db0c830376a549f4a0

See more details on using hashes here.

Provenance

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