Installation
============

CodeVideoRenderer can be installed using pip, the Python package manager.

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

Before installing CodeVideoRenderer, ensure you have the following:

* **Python 3.8 or higher**
* **pip** (Python package installer)
* **FFmpeg** (for video rendering)

Installing FFmpeg
^^^^^^^^^^^^^^^^^

.. tab-set::

   .. tab-item:: Windows

      .. code-block:: bash

         winget install ffmpeg

   .. tab-item:: macOS

      .. code-block:: bash

         brew install ffmpeg

   .. tab-item:: Linux

      .. code-block:: bash

         sudo apt update
         sudo apt install ffmpeg

Basic Installation
------------------

Install CodeVideoRenderer using pip:

.. code-block:: bash

   pip install codevideorenderer

Installation with Extras
------------------------

For additional features, install with optional dependencies:

.. code-block:: bash

   # Install with OpenGL support
   pip install codevideorenderer[opengl]
   
   # Install with all extras
   pip install codevideorenderer[all]

Development Installation
------------------------

To install from source for development:

.. code-block:: bash

   git clone https://github.com/ExploreMaths/CodeVideoRenderer.git
   cd CodeVideoRenderer
   pip install -e .

Verifying Installation
----------------------

Test your installation:

.. code-block:: python

   import CodeVideoRenderer
   print(CodeVideoRenderer.__version__)

Troubleshooting
---------------

Common installation issues:

* **ModuleNotFoundError**: Ensure you're using Python 3.8+
* **FFmpeg not found**: Verify FFmpeg is installed and in PATH
* **Permission errors**: Use ``pip install --user`` or virtual environment

Next Steps
----------

After installation, proceed to the :doc:`tutorials` section to start using CodeVideoRenderer.