Installation

Get Loups installed and running on your system.

---

System Requirements

Python Version Required

Python 3.13 or higher is required.

Loups uses modern Python features and requires Python 3.13+.

Supported Platforms

Platform	Status	Tested
Linux	Fully Supported	CI/CD
macOS	Fully Supported	CI/CD
Windows	Fully Supported	CI/CD

---

Installation Methods

pip (Recommended) uv pipx (Isolated)

The easiest way to install Loups is via pip:

pip install loups

Verify installation:

loups --help

Using the modern uv package manager:

uv pip install loups

Or run directly without installing:

uvx loups --help

For isolated installation:

pipx install loups

This installs Loups in its own virtual environment.

---

Verify Installation

After installation, verify everything is working:

# Check Loups version
loups --version

# View help
loups --help

# Test with a video (if you have one)
loups test_video.mp4

Installation Successful!

If you see the help message, you're all set!

---

Python Version Check

Not sure what Python version you have?

# Check your Python version
python --version

# Or try python3
python3 --version

Upgrading Python

If you need to upgrade to Python 3.13+:

Linux macOS Windows

# Ubuntu/Debian
sudo apt update
sudo apt install python3.13

# Fedora
sudo dnf install python3.13

# Arch
sudo pacman -S python

# Using Homebrew
brew install python@3.13

# Or download from python.org
open https://www.python.org/downloads/

Download the latest Python from python.org

Make sure to check "Add Python to PATH" during installation!

---

Troubleshooting

ModuleNotFoundError

Error: ModuleNotFoundError

Symptom: ModuleNotFoundError or SyntaxError during installation

Solution: You're likely using Python < 3.13. Upgrade Python first.

# Check version
python --version

# Use specific Python version
python3.13 -m pip install loups

First Run is Slow

First Execution Takes Time

Behavior: First run takes several minutes to start

Why: EasyOCR automatically downloads OCR models (~100MB) on first use

Solution: This is normal! Be patient during initial setup. Subsequent runs will be much faster.

The models are cached locally, so you only download once.

Video Codec Issues

Video Won't Open

Error: cv2.error or video file won't open

Solution: Some video formats require additional codecs. Try converting to MP4 (H.264):

# Using ffmpeg
ffmpeg -i input_video.mov -c:v libx264 -c:a aac output_video.mp4

---

Next Steps

Now that you have Loups installed, check out:

• Quick Start Guide - Start using Loups
• CLI Reference - All command options
• Custom Templates - Create your own templates

---

Dependencies

Loups automatically installs these dependencies:

• easyocr - OCR text extraction
• opencv-python-headless - Video processing
• typer - CLI framework
• rich - Beautiful terminal output
• scikit-image - SSIM thumbnail matching

No manual dependency installation needed!