canals 0.3.1

A component orchestration engine for Haystack

Canals

Canals is a component orchestration engine. Components are Python objects that can execute a task, like reading a file, performing calculations, or making API calls. Canals connects these objects together: it builds a graph of components and takes care of managing their execution order, making sure that each object receives the input it expects from the other components of the pipeline.

Canals powers version 2.0 of the Haystack framework.

Installation

Running:

pip install canals

gives you the bare minimum necessary to run Canals.

To be able to draw pipelines, please make sure you have either an internet connection (to reach the Mermaid graph renderer at https://mermaid.ink) or graphviz (version 2.49.0) installed and then install Canals as:

Mermaid

pip install canals[mermaid]

GraphViz

sudo apt install graphviz  # You may need `graphviz-dev` too
pip install canals[graphviz]