
VIDTUBER INSTALLATION INSTRUCTIONS AND BUILDINGS

=============================
Base application dependencies
=============================

    Requires:
        - Python >=3.9.0
        - wxPython >=4.1.0
        - PyPubSub >=4.0.3
        - requests
        - yt-dlp
        - FFmpeg (included ffprobe) >=5.1
    Optionals:
        - atomicparsley (http://atomicparsley.sourceforge.net/)


=========================
Run from source directory
=========================

Vidtuber can be run without installing by extracting the source archive
and executing the "launcher" script inside the source Vidtuber directory.

    cd Vidtuber (source directory)

    python launcher

Vidtuber can also be imported from the Python3 console (interactive mode):

    >>> from vidtuber import gui_app
    >>> gui_app.main()


=====================================
Compiles language translation catalog
=====================================

By default Vidtuber does not include the compiled catalog for language
translations, i.e. `vidtuber.mo` files, especially on development source code.
If you want to compile the language catalog to make the translations available
on Vidtuber, use one of the following options based on your operating system
requirements:

Using `babelutils.py` python script (multi-platform)
----------------------------------------------------

    Requires:
        - babel (also installable via pip)

    cd Vidtuber (source directory)

    python3 develop/gettext_utils/babelutils.py --compile-catalogs --output-dir vidtuber/data/locale --domain vidtuber


======================
Installation using pip
======================

    -----------------------------------------------------------------------
    If you are a Linux/FreeBSD user, the standard installation procedure
    will not install wxPython, as wxPython's PyPi wheels provides support for
    Windows and MacOS only. Please install wxPython manually using your OS's
    package manager.

    Then, this assumes a virtual environment activated using python-venv
    module with `--system-site-package` option to share wxPython module
    installed in your OS,
    like this:

        python -m venv --system-site-packages --upgrade-deps VENV

        source VENV/bin/activate
    ------------------------------------------------------------------------

If you want install dependencies only, inside source directory type:

    python3 -m pip install -r requirements.txt

If you want install dependencies + Vidtuber, Use like this:

    python3 -m pip install git+https://github.com/jeanslack/Vidtuber.git@main -r requirements.txt

On some systems, you may need to use "py" or "python" instead of "python3"

