Skip to main content

A Python SDK for writing Airplane tasks

Project description

Airplane Python SDK PyPI PyPI - License Docs

An SDK for writing Airplane tasks in Python.

Usage

First, install the SDK:

pip install airplanesdk

Next, you can use the SDK to produce outputs which will be separated from your logs:

import airplane

airplane.write_output("Show me what you got")

# You can also separate outputs into groups by attaching names:
airplane.write_named_output("saying", "Show me what you got")
airplane.write_named_output("saying", "Welcome to the club, pal")
airplane.write_named_output("name", "Summer")

This SDK can be used to programmatically kick off tasks and fetch their output:

# You can get a task's ID from the URL bar, f.e.
# https://app.airplane.dev/tasks/1oMt2mZC1DjkOZXxHH8BV57xrmF
task_id = "..."
resp = airplane.run(task_id, {
  # Optionally provide parameters to your task, using the same name
  # as when templating a parameter into your task's CLI args.
  "DryRun": True,
})

# run() will return the run's status (Succeeded, Failed, Cancelled) and a
# dict of outputs, by name.
#
# Default outputs are available as `resp["outputs"]["output"]`.
print(resp["outputs"])

Project details


Download files

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

Files for airplanesdk, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size airplanesdk-0.3.0.tar.gz (4.7 kB) File type Source Python version None Upload date Hashes View
Filename, size airplanesdk-0.3.0-py3-none-any.whl (5.3 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page