Python Environment & Installation Guide

This guide will walk you through setting up a Virtual Python Environment (venv) to run the LipTalk Audio Converter directly from the source code. This is the required method for macOS/Linux users and developers.

πŸ“‹ Prerequisites:
Before you begin, ensure that Python 3.11.5 is installed on your system. If you have a different version or no Python at all, please download it here: Python 3.11.5 Official Download.
Stability Note: This project was developed and tested using Python 3.11.5. Using this specific version ensures that all library dependencies (especially PyTorch and Allosaurus) function correctly.
⚠️ Crucial Dependency Warning:
Strict adherence to the requirements.txt is mandatory if you plan to compile the script into a standalone executable (using PyInstaller or Nuitka). Different versions of PyTorch or other dependencies are known to cause significant packaging errors and broken binaries. While a standard venv might run with newer versions, successful compilation only works with the specified requirements.

βš™οΈ Setting Up the Virtual Environment (venv)

Please execute the following commands within the liptalk_converter_resource_files directory:

πŸͺŸ Windows (CMD / PowerShell)

1. Create the Environment (using 3.11):

py -3.11 -m venv venv

2. Activate the Environment:

venv\Scripts\activate

3. Install Project Dependencies:

python -m pip install .

4. Run the Script:

python liptalk_converter_2026.py

🍎 macOS / 🐧 Linux (Terminal)

1. Create the Environment (using 3.11):

python3.11 -m venv venv

2. Activate the Environment:

source venv/bin/activate

3. Install Project Dependencies:

python3 -m pip install .

4. Run the Script:

python3 liptalk_converter_2026.py
Troubleshooting: If pip install . fails, use the requirements file directly while the venv is active:

Windows: pip install -r requirements.txt
macOS/Linux: pip3 install -r requirements.txt

πŸ“‚ Project Directory Structure