Skip to main content

Airflow provider for Glassdome Waypoint API.

Project description

Glassdome Waypoint Airflow Provider

Airflow provider for the Glassdome Waypoint API. This provider integrates the Glassdome Waypoint SDK with Airflow.

Installation

pip install airflow-providers-glassdome-waypoint

Requirements

  • Python >= 3.10
  • apache-airflow >= 2.11.0
  • apache-airflow-providers-common-compat >= 1.8.0
  • glassdome-waypoint-sdk >= 0.1.0

Quick Start

Connection Configuration

The provider supports below connection configuration:

  • Connection Type: glassdome-waypoint (displayed as Glassdome Waypoint in Airflow UI)
  • Base URL: Your Waypoint API endpoint
  • Auth Type: api_key
  • API Key: Your Glassdome API key
  • Timeout Seconds: Optional request timeout
from glassdome_waypoint.hooks.waypoint import WaypointHook

hook = WaypointHook(your_connection_id)
client = hook.get_client() # WaypointClient instance

Usage Examples

API Reference

WaypointHook

Main entrypoint that provides an authenticated WaypointClient for an Airflow connection.

Methods

  • get_conn(): returns a configured WaypointClient instance.
  • get_client(): alias for get_conn()
  • test_connection(): validates credentials and base URL by calling a lightweight API method.

WaypointClient

Client for interacting with the Waypoint API. More details available in the Waypoint SDK docs.

Attributes

  • client.operation: long-running operations
  • client.site: site APIs
  • client.product: product APIs
  • client.pcf: PCF APIs

Long-Running Operations

Batch import operations return Operation object.

op = client.product.create_products(requests=[...])

# Block until done or timeout
op.wait()

# With return options
op.wait(return_options=OperationReturnOptions(response=True))

# Check for error
if err := op.error():
    print(err.code, err.message)

# Access the response
if resp := op.response():
    # Process response
    pass

Error Handling

The SDK defines these error classes:

  • WaypointError: Base SDK error
  • WaypointHTTPError: HTTP errors
  • AnyUnpackError: Protobuf Any unpacking errors
from glassdome_waypoint_sdk import WaypointError, WaypointHTTPError

try:
    # Your API call
    pass
except WaypointHTTPError as e:
    print(f"HTTP error: {e}")
except WaypointError as e:
    print(f"SDK error: {e}")

License

This SDK is proprietary and may be used only under agreement with Glassdome Inc.

Support

For questions or support, contact: developer@glassdomeinc.com

Project details


Download files

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

Source Distribution

airflow_providers_glassdome_waypoint-0.1.1.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file airflow_providers_glassdome_waypoint-0.1.1.tar.gz.

File metadata

File hashes

Hashes for airflow_providers_glassdome_waypoint-0.1.1.tar.gz
Algorithm Hash digest
SHA256 26e8f004e3b9f2cc01b30fdf72f1202abfcf15307e3e02ba47e15ce8d905b3ee
MD5 2b1d0fa099df0d4e4dc470e4fcf5ea87
BLAKE2b-256 55767565f0441e9e0bf0ab32e19e942cb0154eb402e32917676ba3d1f91d0eb8

See more details on using hashes here.

File details

Details for the file airflow_providers_glassdome_waypoint-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for airflow_providers_glassdome_waypoint-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1178e5f3f84c5d84adce6eb8167091dd7d1aced10c002c16f03b5fcc66f189b
MD5 b5b6d7ed16e3fc8453d5aa3a6bcee550
BLAKE2b-256 b224c37ae095b2624e33e5bc6476cbf451e4000291b0ab7b06cf876b4ec48622

See more details on using hashes here.

Supported by

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