Skip to main content

A Python SDK for writing Airplane tasks

Project description

Airplane Python SDK PyPI PyPI - License Docs

SDK for writing Airplane tasks in Python.

Getting started

pip install airplanesdk

Usage

To write a Python task in Airplane, create a .py file and export a function like so:

import airplane

def main(params):
  return f"Hello, {params['name']}"

You can configure the parameters that your task will receive in the Airplane UI. They'll be passed through the params argument to your function as a dictionary keyed by the slugs you see in the UI.

To execute your task, first install the Airplane CLI.

Once installed, execute your task locally:

airplane dev ./path/to/file.py -- --name=World

If that looks good, deploy your task to Airplane and give it a run in the UI!

airplane deploy ./path/to/file.py

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

airplanesdk-0.3.3.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

airplanesdk-0.3.3-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file airplanesdk-0.3.3.tar.gz.

File metadata

  • Download URL: airplanesdk-0.3.3.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Darwin/21.4.0

File hashes

Hashes for airplanesdk-0.3.3.tar.gz
Algorithm Hash digest
SHA256 b845950df09f271fe4091d56b457b4faadbaaaf6f6bd4727193ade985a0938f3
MD5 ad9985a6a9cadad174495f63baddafb5
BLAKE2b-256 b88a34ebd3156b31b38cdda55511215328b906ccc0f69b983682a059774a6959

See more details on using hashes here.

File details

Details for the file airplanesdk-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: airplanesdk-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Darwin/21.4.0

File hashes

Hashes for airplanesdk-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cc10a4222e4f8f3287a26dc9d3473d03a5d1914ebdd2c89317d466a0cffc02a1
MD5 51cc149d2213b0ea2b97c6e4f6196f40
BLAKE2b-256 6c4e29e110ebf0d7cc712274868d102e0546cb3337b50f7f7e51a649f6e7fe42

See more details on using hashes here.

Supported by

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