Installation¶

This page describes how to install StreamFlow and prepare the environment required to run it.

Requirements¶

Before installing StreamFlow, make sure the following software is available:

FFmpeg is an external system dependency and must be installed separately from the Python packages.

Clone the repository using Git:

git clone https://github.com/S1mon009/StreamFlow.git

Navigate to the project directory:

cd StreamFlow

Using a virtual environment is recommended because it keeps StreamFlow's dependencies isolated from other Python projects.

python -m venv .venv
.\.venv\Scripts\Activate.ps1

python -m venv .venv
.venv\Scripts\activate.bat

python3 -m venv .venv
source .venv/bin/activate

After activation, the terminal should indicate that the virtual environment is active.

Upgrade pip:

python -m pip install --upgrade pip

Then install the project's dependencies:

pip install -r requirements.txt

StreamFlow relies on FFmpeg for multimedia processing and verifies its availability before downloading.

Install FFmpeg and add its executable directory to the system PATH.

Verify the installation:

ffmpeg -version

sudo apt update
sudo apt install ffmpeg

Verify:

ffmpeg -version

If Homebrew is installed:

brew install ffmpeg

Then:

ffmpeg -version

Run StreamFlow from the project root:

python main.py

If the environment has been configured correctly, the application starts and displays its interactive terminal interface.

Verify that Python is installed and available in PATH:

python --version

On some Linux systems:

python3 --version

Run:

ffmpeg -version

If the command is unavailable, install FFmpeg and make sure its executable directory is present in PATH.

Make sure the virtual environment is activated before running:

pip install -r requirements.txt