Skip to content

Installation

Requirements

Before installing the Mosaico framework, you need to make sure you have the following prerequisites:

  1. Python 3.10 or superior

    Mosaico requires Python 3.10 or superior. You can check your Python version by running:

    python --version

    If you need to update or install Python, visit python.org to get the latest version.

  2. FFmpeg

    Mosaico depends on FFmpeg for video processing. You must have FFmpeg installed and available in your system PATH.

    To check if FFmpeg is installed, run:

    ffmpeg -version

    If it's not installed, you can get it from ffmpeg.org or use your operating system's package manager.

    sudo apt update
sudo apt install ffmpeg

    brew install ffmpeg

    choco install ffmpeg

After ensuring these prerequisites are satisfied, you can proceed with the Mosaico installation.

Installation

To install Mosaico, run the following command according to your preferred package manager:

pip install mosaico

pipx install mosaico

uv add mosaico

poetry add mosaico

pdm add mosaico

It is also possible to install Mosaico from source by cloning the repository and running the following command:

git clone https://github.com/folhalab/mosaico.git
cd mosaico
pip install -e .

Additional Dependencies

To install optional dependencies for Mosaico, use the following command, replacing news with the desired feature or concatenating multiple features separated by commas:

pip install "mosaico[news]"

pip install "mosaico[news,elevenlabs,assemblyai]"

Available features and their dependencies are listed below:

Feature Component Dependencies Description
news script generator litellm, instructor AI-powered script generation for videos
openai speech synthesizer, audio transcriber openai Text-to-speech synthesis and audio transcription integrations with OpenAI
elevenlabs speech synthesizer elevenlabs Text-to-speech synthesis integration with ElevenLabs
assemblyai audio transcriber assemblyai Audio transcription integration with AssemblyAI