API Reference

This API reference is automatically generated from Prefect's source code and unit-tested to ensure it's up to date.

Hello, world! 👋

We've rebuilt data engineering for the data science era.

Prefect is a new workflow management system, designed for modern infrastructure and powered by the open-source Prefect Core workflow engine. Users organize Tasks into Flows, and Prefect takes care of the rest.

Read the docs; get the code; ask us anything!

from prefect import task, Flow


@task
def say_hello():
    print("Hello, world!")


with Flow("My First Flow") as flow:
    say_hello()


flow.run() # "Hello, world!"

Docs

Prefect's documentation -- including concepts, tutorials, and a full API reference -- is always available at docs.prefect.io.

Instructions for contributing to documentation can be found in the development guide.

Contributing

Read about Prefect's community or dive in to the development guides for information about contributions, documentation, code style, and testing.

Join our Slack to chat about Prefect, ask questions, and share tips.

Prefect is committed to ensuring a positive environment. All interactions are governed by our Code of Conduct.

"...Prefect?"

From the Latin praefectus, meaning "one who is in charge", a prefect is an official who oversees a domain and makes sure that the rules are followed. Similarly, Prefect is responsible for making sure that workflows execute properly.

It also happens to be the name of a roving researcher for that wholly remarkable book, The Hitchhiker's Guide to the Galaxy.

Installation

Requirements

Prefect requires Python 3.5.2+.

Install latest release

Using pip:

pip install prefect

or conda:

conda install -c conda-forge prefect

or pipenv:

pipenv install --pre prefect

Install bleeding edge

Please note that the master branch of Prefect is not guaranteed to be compatible with Prefect Cloud.

git clone https://github.com/PrefectHQ/prefect.git
pip install ./prefect

License

Prefect is licensed under the Apache Software License version 2.0.

This documentation was auto-generated from commit n/a
on November 26, 2019 at 16:53 UTC