https://github.com/flyteorg/flytekit

Extensible Python SDK for developing Flyte tasks and workflows. Simple to get started and learn and highly extensible.
https://github.com/flyteorg/flytekit

automation data data-science extensible flyte flyte-tasks hacktoberfest mlops pypi python sdk spark workflows

Last synced: about 17 hours ago
JSON representation

Extensible Python SDK for developing Flyte tasks and workflows. Simple to get started and learn and highly extensible.

• Host: GitHub
• URL: https://github.com/flyteorg/flytekit
• Owner: flyteorg
• License: apache-2.0
• Created: 2019-08-21T17:38:38.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-06T00:19:38.000Z (6 days ago)
• Last Synced: 2024-12-06T00:24:37.483Z (6 days ago)
• Topics: automation, data, data-science, extensible, flyte, flyte-tasks, hacktoberfest, mlops, pypi, python, sdk, spark, workflows
• Language: Python
• Homepage: https://docs.flyte.org/en/latest/api/flytekit/docs_index.html
• Size: 38.5 MB
• Stars: 253
• Watchers: 240
• Forks: 299
• Open Issues: 146
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-repositories - flyteorg/flytekit - Extensible Python SDK for developing Flyte tasks and workflows. Simple to get started and learn and highly extensible. (Python)

README

        


    





    Flytekit Python





    Flytekit Python is the Python SDK built on top of Flyte





    Plugins

     · 

    Contribution Guide



[![PyPI version fury.io](https://badge.fury.io/py/flytekit.svg)](https://pypi.python.org/pypi/flytekit/)

[![PyPI download day](https://img.shields.io/pypi/dd/flytekit.svg)](https://pypi.python.org/pypi/flytekit/)

[![PyPI download month](https://img.shields.io/pypi/dm/flytekit.svg)](https://pypi.python.org/pypi/flytekit/)

[![PyPI total download](https://static.pepy.tech/badge/flytekit)](https://static.pepy.tech/badge/flytekit)

[![PyPI format](https://img.shields.io/pypi/format/flytekit.svg)](https://pypi.python.org/pypi/flytekit/)

[![PyPI implementation](https://img.shields.io/pypi/implementation/flytekit.svg)](https://pypi.python.org/pypi/flytekit/)

[![Codecov](https://img.shields.io/codecov/c/github/flyteorg/flytekit?style=plastic)](https://app.codecov.io/gh/flyteorg/flytekit)

[![PyPI pyversions](https://img.shields.io/pypi/pyversions/flytekit.svg)](https://pypi.python.org/pypi/flytekit/)

[![Docs](https://readthedocs.org/projects/flytekit/badge/?version=latest&style=plastic)](https://flytekit.rtfd.io)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)

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](https://flyte.org)

 - [Flyte core repository](https://github.com/flyteorg/flyte)

## 🚀 Quick Start

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

### Installation

```bash

pip install flytekit

```

### A Simple Example

```python

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](https://docs.flyte.org/en/latest/user_guide/quickstart_guide.html)

- [Flytekit API documentation](https://docs.flyte.org/en/latest/api/flytekit/docs_index.html)

## 📖 How to Contribute to Flytekit

You can find the detailed contribution guide [here](https://docs.flyte.org/en/latest/api/flytekit/contributing.html). Plugins' contribution guide is included as well.

## Code Structure

Please see the [contributor's guide](https://docs.flyte.org/en/latest/api/flytekit/contributing.html) for a quick summary of how this code is structured.

## 🐞 File an Issue

Refer to the [issues](https://github.com/flyteorg/flyte/issues) section in the contribution guide if you'd like to file an issue.

## 🔌 Flytekit Plugins

Refer to [plugins/README.md](plugins/README.md) for a list of available plugins.

There may be plugins outside of this list, but the core maintainers maintain this list.