ddelange / prefect

The easiest way to coordinate your dataflow

Prefect 2

Prefect 2 is the second-generation dataflow coordination and orchestration platform from Prefect.

Prefect 2 has been designed from the ground up to handle the dynamic, scalable workloads that the modern data stack demands. Powered by Prefect Orion, a brand-new, asynchronous rules engine, it represents an enormous amount of research, development, and dedication to a simple idea:

You should love your workflows again.

Read the docs, run the code, or host the UI. Join thousands of community members in our Slack community to share your thoughts and feedback. Thanks for being part of the mission to build a new kind of workflow system and, of course, happy engineering!

"Don't Panic"

Still using Prefect 1 Core and Server? Find the legacy Prefect 1 docs at https://docs-v1.prefect.io/.

---

Hello, Orion!

Powered by the Orion engine, Prefect is the easiest way to transform any function into a unit of work that can be observed and governed by orchestration rules.

Add workflow features like retries, distributed execution, scheduling, caching, and much more, with minimal changes to your code. Every activity is tracked and becomes visible in the Orion Dashboard.

from prefect import flow, task
from typing import List
import httpx


@task(retries=3)
def get_stars(repo: str):
    url = f"https://api.github.com/repos/{repo}"
    count = httpx.get(url).json()["stargazers_count"]
    print(f"{repo} has {count} stars!")


@flow(name="GitHub Stars")
def github_stars(repos: List[str]):
    for repo in repos:
        get_stars(repo)


# run the flow!
github_stars(["PrefectHQ/Prefect"])

After running some flows, fire up the UI to gain insight into their execution:

prefect orion start

From here, you can continue to use Prefect interactively or set up automated deployments.

Next steps

Prefect 2 was designed to be incrementally adopted into your workflows, and our documentation is organized to support your exploration as much as possible. It is organized into four main sections whose applicability will depend on your objectives and comfort level.

Getting started

Begin by installing Prefect on your machine--Prefect currently supports the following Python versions: 3.7, 3.8, 3.9, 3.10. Then follow one of our friendly tutorials to learn by example. See the Getting Started overview for more.

Concepts

Learn more about Prefect's features and design by reading our in-depth concept docs. These are intended to introduce the building blocks of Prefect, build up to orchestration and deployment, and finally cover some of the advanced use cases that Prefect makes possible.

Frequently asked questions

Prefect 2 represents a fundamentally new way of building and orchestrating data workflows. Learn more about the project by reading our FAQ.

API reference

Prefect provides a number of programmatic workflow interfaces, each of which is documented in the API Reference. This is where you can learn how a specific function works, or see the expected payload for a REST endpoint.

Contributing

See our documentation on contributing to Prefect 2.

Join the community

Prefect 2 was made possible by the fastest-growing community of data engineers. The Prefect Slack community is a fantastic place to learn more, ask questions, or get help with workflow design. The Prefect Discourse is an additional community-driven knowledge base to find answers to your Prefect-related questions. Join us and thousands of friendly data engineers to help build a new kind of workflow system.