A Python SDK for writing Airplane tasks
Project description
Airplane Python SDK
An SDK for writing Airplane tasks in Python.
Usage
First, install the SDK:
pip install airplane
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 = "..."
run_output = 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 a dict of outputs, by name.
# Default outputs are available as `run_output.output`.
print(run_output)
Contributing
Deployment
To deploy a new version of this SDK:
- Bump the version number in
pyproject.toml
andairplane/__init__.py
- Run the following to build and publish to PyPI:
poetry publish --build --username=airplane
Project details
Release history Release notifications | RSS feed
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.1.3.tar.gz
(3.7 kB
view hashes)
Built Distribution
Close
Hashes for airplanesdk-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2399c5fac4d0c0a4a208cede139ebcdad3327ca4bae2d73a218d0fb8912259ed |
|
MD5 | 793e44b10126726293f003b556c8eace |
|
BLAKE2b-256 | 312600a5542979801812aa38740893cc3accd02fe5e3040d63e9b3ab972ad852 |