Skip to main content

Shared helper utilities for Airflow Xtra plugins.

Project description

🧰 Air-Labs Helpers

The Helpers module provides shared utilities used across all Air-Labs plugins.
It standardizes how plugins interact with the Airflow REST API and connection management.


🔧 Features

  • Centralized API client (AirflowClient) for REST API interaction
  • Built-in authentication support using /auth/token
  • Simplified connection management via Airflow’s conn_id
  • Consistent response formatting and error handling

🧮 Usage Example

from air_labs_helpers.client import AirflowClient

client = AirflowClient(conn_id="airflow_api_conn")
report = client.pause_dags(name_prefix="etl_")
print(report)

Connection Setup (Required)

Before using the client, create a connection in the Airflow UI → Admin → Connections.

Field Description Example
Conn Id Used in code airflow_api_conn
Conn Type http or https http
Host Airflow Webserver http://localhost:8080
Login Username / Service Account admin
Password Password or API token mysecret

How It Works

  1. Loads the Airflow connection from conn_id
  2. Authenticates via /auth/token
  3. Sends REST API requests to /api/v1/...
  4. Returns structured results

🧾 License

MIT © Rahul Rajasekharan

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

air_labs_helpers-0.1.1.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

air_labs_helpers-0.1.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: air_labs_helpers-0.1.1.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for air_labs_helpers-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b7f39a0f70a6e3b87b687a39b885cf0f19a61bc3c8aa4857ddd36c507c24ac22
MD5 a0b7331c719054271b82f74f4172bf94
BLAKE2b-256 26d862dede5ee927c7745d2a42bc513c6fa3a06d6f191cff628e1facebe21763

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for air_labs_helpers-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 98ee66c76dec8cdaf4b36fe94266a94ced4496769991f7c9055b0812c375a7ac
MD5 403a233961411af4a162fc02e51ad57c
BLAKE2b-256 fc53d2cefe2699ac45e6442d14560fb53cb2f1ae90504fbc9ee4a3173e2ba317

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