songs2slides

A tool that automatically finds song lyrics and creates lyric slideshows
git clone https://git.ashermorgan.net/songs2slides/
Log | Files | Refs | README

README.md (802B)


      1 # Songs2Slides
      2 A tool that automatically finds song lyrics and creates lyric slideshows
      3 
      4 ## Setup
      5 Install Python dependencies:
      6 ```
      7 python3 -m pip install -r requirements.txt
      8 ```
      9 
     10 Add API environment variables to a `.env` file:
     11 ```
     12 # Song lyric API with {title} and {artist} placeholders
     13 API_URL="http://example.com/get-lyrics?title={title}&artist={artist}"
     14 
     15 # Optional API authentication header
     16 API_AUTH="Bearer secrettoken"
     17 ```
     18 
     19 Run Songs2Slides on [localhost:5000](http://localhost:5000)
     20 ```
     21 flask --app songs2slides run
     22 ```
     23 
     24 ## Screenshots
     25 Screenshots of Songs2Slides with `mock_api.py` as the API:
     26 
     27 ![Step 1: Select Songs](screenshots/step-1.png)
     28 
     29 ![Step 2: Review lyrics](screenshots/step-2.png)
     30 
     31 ![Step 3: Create slideshow](screenshots/step-3.png)
     32 
     33 ![Completed slideshow](screenshots/slides.png)