Welcome to Watcher SDK’s documentation!

The Watcher SDK is a Python library for interacting with the Watcher framework.

Installation

You can install the Watcher SDK using your preferred package manager:

pipuvpoetry

pip install etl-watcher-sdk

Getting Started

• Quick Start Guide
  • Installation
  • Usage

API

• Core Models
  • ETLResult
  • WatcherContext
  • ExecutionResult
• Pipeline Configuration
  • Pipeline
  • PipelineConfig
  • SyncedPipelineConfig
• Address Lineage
  • Address
  • AddressLineage
• Error Handling
  • WatcherAPIError
  • WatcherNetworkError

Guides

• Address Management
  • Address Lineage Configuration
  • Loading Address Lineage
• Authentication
  • Overview
  • Supported Cloud Environments
  • Basic Usage
  • Explicit Authentication Configuration
  • Cloud-Specific Configuration
  • Environment Variables
  • Installation with Cloud Dependencies
  • Orchestration Integration
  • Error Handling
  • Common Issues
  • Best Practices
  • Example: Complete Cloud Deployment
• Execution Management
  • Logging Executions
  • Custom ETL Results
  • ETL Results
  • Execution Results
  • Hierarchical Executions
  • Watcher Execution Context
  • Active Flag
  • Manual Execution Management
• Monitoring
  • Trigger Timeliness Check
  • Trigger Freshness Check
  • Trigger Celery Queue Check
• Orchestration Integration
  • Overview
  • Basic Usage
  • Dagster Integration
  • Airflow Integration
  • Advanced Usage
  • Error Handling
  • Best Practices
• Watermark Management
  • Incrementing Watermarks
  • Accessing Watermarks
  • Watermark Data Type