Installing from PyPI

This page describes installations using the ai-flow package published in PyPI.

Prerequisites

AIFlow is tested with:

  • Python: 3.7, 3.8

  • Pip: 19.0.0+

  • SQLite: 3.15.0+

Note: SQLite is only used in tests and getting started. To use AIFlow in production, please set up MySQL as the backend.

Installing AIFlow

Preparing Environment [Optional]

To avoid dependencies conflict, we strongly recommend using venv or other similar tools for an isolated Python environment like below:

python3 -m venv venv_for_aiflow
source venv_for_aiflow/bin/activate

Now you can install the latest AIFlow package by running:

python3 -m pip install ai-flow-nightly

Congrats, you are ready to run AIFlow and try core features following the quickstart.

Extra Dependencies

The ai-flow-nightly PyPI basic package only installs what’s needed to get started. Additional packages can be installed depending on what will be useful in your environment. For instance, when you are setting MySQL as the metadata backend, you need to install mysqlclient by following command:

python -m pip install 'ai-flow-nightly[mysql]'

For the list of the extras and what they enable, see: Reference for package extras.