Manually Install kbp2video
==========================

.. _prereqs:

Prerequisites
-------------

Manually installing kbp2video requires two main dependencies, Python 3 (3.10 or higher) and ffmpeg (6 or higher).

Almost any Linux distro will have both of these available in their package managers.

On Windows, you can download Python from its `official site <https://www.python.org/>`_, and it's also available in the Microsoft store and several package managers for Windows as well. For Windows builds of ffmpeg, I recommend the ones from `gyan.dev <https://www.gyan.dev/ffmpeg/builds/>`_. kbp2video uses both the ffmpeg and ffprobe binaries. You will need to add the ffmpeg bin directory to your PATH or kbp2video will prompt for it each time it opens.

On Mac, you can also download Python from the `official site <https://www.python.org/>`_ or via a repository like `Homebrew <https://brew.sh/>`_ or `MacPorts <https://www.macports.org/>`_. Note that the version of Python bundled with old versions of MacOS was Python 2 so would not be usable. ffmpeg doesn't have an official build for Mac, and its recommended builds are Intel-only, so Homebrew, MacPorts, or similar are probably your best options for that.

Install from PyPi
-----------------

Once you have the :ref:`prereqs`, you can install kbp2video with pip:

.. code-block:: bash

   python3 -m pip install kbp2video


Install from Git
----------------

If you want to install directly from the repo, you can do so either using a normal Git clone or downloading a release zip/tar, then from within the directory run (optionally from within a venv):

.. code-block:: bash

   python3 -m pip install .

The repo has a pyproject.toml which will take care of handling Python dependencies automatically, but you still need the :ref:`prereqs`

Run it
------

Once installed manually, you can run it with

.. code-block:: bash

   python3 -m kbp2video

If you are using a venv or otherwise have the pip's bin or scripts directory in your path, you can also just run

.. code-block:: bash

   kbp2video