# Installation

## Requirements

You can install bbbdl on any computer with the following software already installed:

- Python 3.8+

- ffmpeg

## Installing bbbdl

bbbdl is distributed through PyPI, the Python Package Index.

### Using pipx

The easiest way to install bbbdl, but requires pipx to be installed separately.

Run the following command in a terminal or command prompt:

    pipx install bbbdl

This will install bbbdl for the current user in an isolated environment so that the dependencies don’t conflict with other software already on your system.

### Using pip and venv

If pipx is not available, you can manually install bbbdl in a virtual environment (venv).

First, create a venv:

    python -m venv venv

Then, enter the venv:

    # Assuming you're using Linux
    source venv/bin/activate

While inside the venv, install bbbdl with pip:

    pip install bbbdl

Done! Remember that, if you install bbbdl using this method, you’ll need to have entered the venv in that terminal session to use bbbdl!

### For development

If you want to contribute to bbbdl, you’ll need to install it from source in editable mode.

This requires Git and Poetry, ensure to have both of them installed.

First, fork the repository on GitHub:

Then, clone the forked repository on your computer and enter the created directory:

    git clone https://github.com/YOUR-USERNAME-HERE/bbbdl
    cd bbbdl

Finally, automatically create a venv and install all dependencies with Poetry:

    poetry install

This installs bbbdl in a Poetry venv, which you can access with:

    poetry shell