Skip to main content

Workflow orchestration and management.

Project description

PyPI

Prefect

Prefect is an orchestration and observation platform for building and reacting to workflows. It's the simplest way to transform Python code into an interactive workflow application.

With Prefect you can standardize workflow deployment across your organization.

You can build resilient, dynamic workflows that react to the world around them and recover from unexpected changes.

With just a few decorators, Prefect supercharges your code with features like automatic retries, distributed execution, scheduling, caching, and much more.

Workflow activity is tracked and can be monitored with a self-hosted Prefect server instance or managed Prefect Cloud dashboard.

Getting started

Prefect requires Python 3.9 or later. To install the latest or upgrade to the latest version of Prefect, run the following command:

pip install -U prefect

Then create and run a Python file that uses Prefect flow and task decorators to orchestrate and observe your workflow - in this case, a simple script that fetches the number of GitHub stars from a repository:

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


@task(log_prints=True)
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!
if __name__=="__main__":
    github_stars(["PrefectHQ/Prefect"])

Fire up the Prefect UI to see what happened:

prefect server start

Prefect UI dashboard

To run your workflow on a schedule, turn it into a deployment and schedule it to run every minute by changing the last line of your script to the following:

if __name__ == "__main__":
    github_stars.serve(name="first-deployment", cron="* * * * *")

You now have a server running locally that is looking for scheduled deployments! Additionally you can run your workflow manually from the UI or CLI - and if you're using Prefect Cloud, you can even run deployments in response to events.

Prefect Cloud

Stop worrying about your workflows. Prefect Cloud allows you to centrally deploy, monitor, and manage the data workflows you support. With managed orchestration, automations, and webhooks, all backed by enterprise-class security, build production-ready code quickly and reliably.

Read more about Prefect Cloud here or sign up to try it for yourself.

Prefect Automations Prefect Automations Prefect Automations

prefect-client

If your use case is geared towards communicating with Prefect Cloud or a remote Prefect server, check out our prefect-client. It is a lighter-weight option for accessing client-side functionality in the Prefect SDK and is ideal for use in ephemeral execution environments.

Next steps

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

prefect-3.0.0rc5.tar.gz (5.7 MB view details)

Uploaded Source

Built Distribution

prefect-3.0.0rc5-py3-none-any.whl (6.0 MB view details)

Uploaded Python 3

File details

Details for the file prefect-3.0.0rc5.tar.gz.

File metadata

  • Download URL: prefect-3.0.0rc5.tar.gz
  • Upload date:
  • Size: 5.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for prefect-3.0.0rc5.tar.gz
Algorithm Hash digest
SHA256 5b8f07446012dd45e0ff63ee3756d764e1661f904f7e9773c2050b74e0e08511
MD5 4ea0318bdba1240d64021251954b3d07
BLAKE2b-256 b17c73713c42e1bb0c90a1e2366cde81d75e0f7f505c8a8d68fdaa521dbebf7a

See more details on using hashes here.

File details

Details for the file prefect-3.0.0rc5-py3-none-any.whl.

File metadata

  • Download URL: prefect-3.0.0rc5-py3-none-any.whl
  • Upload date:
  • Size: 6.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for prefect-3.0.0rc5-py3-none-any.whl
Algorithm Hash digest
SHA256 e003e622178d2334bbc67e96fb80fb0b1b068100bf03d27b92cc46f7b161d27c
MD5 abbed4a5dbdc7100dccef5f7c23d24e9
BLAKE2b-256 3c32a0b5cfe0f68a3dfbbd31a7291e34790f1c259893b807e83325262f2c5153

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