Skip to content

Installation

This guide covers all the ways to install Chicory and its optional dependencies.

Requirements

Chicory requires:

  • Python 3.11 or higher
  • pip or uv for package management

Basic Installation

The basic installation includes core Chicory functionality with no broker or backend:

pip install chicory

Note

The basic installation doesn't include any broker or backend. You'll need to install extras for full functionality.

Installing with Extras

Chicory uses optional dependencies (extras) for different brokers and backends. Install only what you need:

Redis Support

For Redis as both broker and backend:

pip install chicory[redis]

Use case: Simple setup, great for development and many production scenarios

RabbitMQ Support

For RabbitMQ as a broker:

pip install chicory[rabbitmq]

Use case: Enterprise messaging, advanced routing, high reliability requirements

PostgreSQL Support

For PostgreSQL as a backend:

pip install chicory[postgres]

Use case: When you already use PostgreSQL and want task results in your database

MySQL Support

Experimental

MySQL backend support is experimental and not tested. Use at your own risk.

For MySQL as a backend:

pip install chicory[mysql]

SQLite Support

Experimental

SQLite backend support is experimental and not tested. Use at your own risk.

For SQLite as a backend:

pip install chicory[sqlite]

MS SQL Server Support

Experimental

MS SQL Server backend support is experimental and not tested. Use at your own risk.

For Microsoft SQL Server as a backend:

pip install chicory[mssql]

CLI Support

For the command-line interface:

pip install chicory[cli]

All Extras

To install everything:

pip install chicory[all]

This includes all brokers, backends, and the CLI.

Use case: Development, testing, or when you want maximum flexibility

Combining Extras

You can install multiple extras at once:

# Redis broker + PostgreSQL backend + CLI
pip install chicory[redis,postgres,cli]

# RabbitMQ broker + Redis backend + CLI
pip install chicory[rabbitmq,redis,cli]

Next Steps

Now that Chicory is installed, continue to: