Skip to content

Installation

Note

This guide is for end users using Audim for creating podcast videos. For developers and contributors, see Development.

Prerequisites

  • 🐍 Python ≥ 3.10
  • 🖥️ Conda or venv
  • 🎥 FFmpeg (recommended, for faster video encoding)

Setup

1. Install Audim

It is recommended to install audim in a virtual environment from PyPI or Conda in a Python=3.10 environment.

Activate your virtual environment (recommended):

source .venv/bin/activate

Install audim using pip:

pip install audim

Create a new environment using Conda:

conda create -n my-project python=3.10

Activate your virtual environment:

conda activate my-project

Install pip and audim using conda:

conda install pip
pip install audim

Note

By installing audim from source, you can explore the latest features and enhancements that have not yet been officially released.

Note

Please note that the latest changes may be still in development and may not be stable and may contain bugs.

Install from source

pip install git+https://github.com/mratanusarkar/audim.git

Using local FFmpeg is optional but recommended for speeding up the video encoding process.

Install FFmpeg

sudo apt install ffmpeg libx264-dev

brew install ffmpeg

choco install ffmpeg

Download and install FFmpeg from the official website:

Download and install FFmpeg from the official website:

Start your project

Create input and output directories

mkdir ./input ./output

Create a run.py or test.py to write your python script using audim and start creating your podcast videos.

touch run.py

Ideally, if done correctly, the setup should look like this:

your-project/
├── .venv/
├── input/
├── output/
└── run.py # or test.py

Now, you are all set!

  • Go ahead and create your python script in run.py to start creating your podcast videos.
  • See Usage for more details or see sample scripts to get some inspiration.
  • Once done, you would dump your input files in the input directory.
  • The output files will be generated in the output directory on running the script.

Run the script using:

python run.py

Feel free to share your generations and tag us!