Skip to content

Installation

Python setup

Prefect requires Python 3.7+

We recommend installing Orion using a Python virtual environment manager such as pipenv, conda or virtualenv.

Installing the latest version

Prefect is published as a Python package. To install the latest 2.0 release, run the following in a shell, using the pre-release version of Orion you want to test:

pip install -U "prefect>=<version>"

For example, to install the latest 2.0a6 version:

pip install -U "prefect>=2.0a6"

Find the available release versions in the Orion Release Notes or the PyPI release history.

Installing the bleeding edge

If you'd like to test with the most up-to-date code, you can install directly off the orion branch on GitHub:

pip install git+https://github.com/PrefectHQ/prefect@orion

orion may not be stable

Please be aware that this method installs unreleased code and may not be stable.

Installing for development

If you'd like to install a version of Prefect for development, first clone the Prefect repository and then install in editable mode with pip:

git clone https://github.com/PrefectHQ/prefect.git 
# or git clone git@github.com:PrefectHQ/prefect.git if SSH is preferred
cd prefect/
git checkout orion
pip install -e ".[dev]"

Checking your installation

To check that Prefect was installed correctly, you can test the Prefect CLI:

$ prefect version
2.0a6

Running this command should print a familiar looking version string to your console.

External requirements

While Prefect Orion works with many of your favorite tools and Python modules, Orion has a few external dependencies.

SQLite

Prefect Orion uses SQLite as the default backing database, but it is not packaged with the Orion installation. Most systems will have SQLite installed already since it is typically bundled as a part of Python. Orion requires SQLite version 3.24.0 or later.

You can check your SQLite version by executing the following command in a terminal:

$ sqlite3 --version