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

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.0.tar.gz.

File metadata

File hashes

Hashes for airflow_providers_glassdome_waypoint-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f34e395ed69ea5a851b5c2b34af618cc26b44b31e64341771daf419a9687ee9a
MD5 69ce6ed04df9b4f3fb89b96ab8741967
BLAKE2b-256 96241e5b943e3f8bbafa34144c6dbbb9bdac69d66bdecf6adf69e1a611ae90fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airflow_providers_glassdome_waypoint-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 558d75f6626f1bf7f6fbd15038cb2931b63c6481e004e62d0cbbe42eb9dff5df
MD5 b17e9a0d53a53983f0bda24f9a3feac6
BLAKE2b-256 ac1f0910ded31258162640c22f6ce4c87443c9ce53bc028b04ab06c029e367c2

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