[!IMPORTANT]

Looking for Flyte 2?

• ⭐️ Flyte 2 Devbox is now available! Check out the guide here
• Use Flyte 2 locally? Head to flyte-sdk — the new Python SDK for Flyte 2.
• Want to contribute to the Flyte 2 distributed backend? See the main branch of this repo.

The README below is for Flyte 1.x.

Flytekit Python

Flytekit Python is the Python SDK built on top of Flyte

Plugins · Contribution Guide

Flytekit Python is the Python Library for easily authoring, testing, deploying, and interacting with Flyte tasks, workflows, and launch plans.

If you haven't explored Flyte yet, please refer to:

• Flyte homepage
• Flyte core repository

🚀 Quick Start

Flytekit is the core extensible library to author Flyte workflows and tasks and interact with Flyte backend services.

Installation

pip install flytekit

A Simple Example

from flytekit import task, workflow

@task(cache=True, cache_version="1", retries=3)
def sum(x: int, y: int) -> int:
    return x + y

@task(cache=True, cache_version="1", retries=3)
def square(z: int) -> int:
    return z*z

@workflow
def my_workflow(x: int, y: int) -> int:
    return sum(x=square(z=x), y=square(z=y))

📦 Resources

• Learn Flytekit by example
• Flytekit API documentation

📖 How to Contribute to Flytekit

You can find the detailed contribution guide here. Plugins' contribution guide is included as well.

Code Structure

Please see the contributor's guide for a quick summary of how this code is structured.

🐞 File an Issue

Refer to the issues section in the contribution guide if you'd like to file an issue.

🔌 Flytekit Plugins

Refer to plugins/README.md for a list of available plugins. There may be plugins outside of this list, but the core maintainers maintain this list.