Skip to content

Installing Dependencies

Installing prerequisites

brew install ffmpeg

apt-get install ffmpeg libavcodec-extra

libav.org is down

It seems the Windows binaries website is down. If you find an alternative method to install Companion on Windows, please update on the open issue on GitHub.

  1. Download and extract libav from the Windows binaries.
  2. Add the libav's /bin folder to your PATH envvar

Installing environment

  1. Create a new virtual environment (optional)

  2. Clone the repository, either by downloading the files from GitHub or by running: 

    git clone https://github.com/shakedzy/companion.git

  3. From the main companion directory, run: 
    pip install -r requirements.txt

Keys file

This is optional, and not required.

You may add a keys.yml file which will hold your OpenAI API configurations and/or a Google Cloud Service Account to be used to access these required services. It allows you to override the local OpenAI API key or Google Cloud SDK (or when they cannot be installed).

Private keys

Your API and Service Account keys are private and shouldn't be shared, as they allow access your OpenAI and Google Cloud services without any password or additional logins. Do not save or share this file publicly online nor commit it to GitHub. This file should remain only on your machine.

Keys file example: 

openai:
  api_key: 'sk-...'
  base_url: '...'

google_sa:
  ...

openai

  • api_key: Use this Open API key instead of the one found in your OPENAI_API_KEY environment variable. You can redirect to another environment variable by using the variable name with a prefix $ prefix (i.e. $ANOTHER_SERVICE_API_KEY)
  • base_url: Use this URL instead of the default one

google_sa

Insert here all your Google Service Account credentials key-values in order to authenticate with Google Cloud using this Service Account instead of using Google Cloud SDK client.

Service Account roles

The Service Account used for this app will require the Service Usage Consumer role.