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.7.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

airplanesdk-0.3.7-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for airplanesdk-0.3.7.tar.gz
Algorithm Hash digest
SHA256 d3fff372251602deddc4de83cf6b1739bda65b059c900778412ac39216651b20
MD5 35f4d4c6ab2d51e3d2820e9c1760e575
BLAKE2b-256 f7e4b2e1488e715256f0ce626521a292df2740333f48dde55151b2cb9c93135b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for airplanesdk-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b4d10e68702bf657ede3954994ada13de6cb310f402e0ef5b6e723015b0cf7f0
MD5 475c997aad2b7714b7bca54ce180527b
BLAKE2b-256 c3630222a1db82e4a41def42de523eec9319069c4db6834509d92ee066a06e36

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