airplanesdk 0.1.1

A Python SDK for writing Airplane tasks

Airplane Python SDK

An SDK for writing Airplane tasks in Python.

Usage

First, install the SDK:

pip install airplanesdk

Next, import the SDK and create a client:

from airplanesdk import Airplane

airplane = Airplane()

You can then use the SDK to produce outputs which will be separated from your logs:

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

# You can also separate outputs into groups by attaching names:
airplane.writeNamedOutput("saying", "Show me what you got")
airplane.writeNamedOutput("saying", "Welcome to the club, pal")
airplane.writeNamedOutput("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
taskId = "..."
runOutput = airplane.run(taskId, {
  # 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 a dict of outputs, by name.
# Default outputs are available as `runOutput.output`.
print(runOutput)

Contributing

Deployment

To deploy a new version of this SDK:

1. Bump the version number in pyproject.toml and airplanesdk/__init__.py
2. Run the following to build and publish to PyPI:

poetry publish --build --username=airplane