Summer school project

Setup

# clone repo
git clone https://github.com/VIVES-project/playlist-gen

# create virtual environment
python -m venv venv

# activate virtual environment
source venv/Scripts/activate

# install requirements
pip install -r requirements.txt

Then create an .env file with the following API keys:

OPENAI_API_KEY=....
SPOTIFY_CLIENT_ID=...
SPOTIFY_CLIENT_SECRET=...

If you're part of the VIVES project team, you can download the .env file directly from our shared google drive folder and paste it in the project's root directory. Check that the dot wasn't removed from the filename after download and that it's correctly ignored by git.

(optional) Create your own API key and client secrets.

Check this tutorial for setting up your OpenAI API key, and this one for the spotify client id and client secret.

Important: you will also need to add specific user accounts to this list, to be able to interact with the app in development mode:

Usage

# activate virtual environment
source venv/Scripts/activate

# run script, for example the image caption demo:
python imgCaption.py

Start streamlit UI

# activate virtual environment
source venv/Scripts/activate

streamlit run st-example.py

The first time, activate the "run on save" option here:

You can also edit the visual theme there.