Songogram Documentation

This is the documentation for Songogram: an open-source webapp for sending songograms to your friends. A songogram is a robocall that reads your friend the lyrics of a song on the phone with a follow-up text.

Installation

You can clone the repository via the command line:
git clone https://github.com/calthoff/sonogram.git

Dependencies

To use Songogram, first install its dependencies using pip freeze:
pip install requirements.txt

Environmental Variables

In web_app.py you need to set the following variables with your information from your Vonage account. You can get this information by registering for an account on https://developer.nexmo.com/

APPLICATION_ID = 'Your Vonage application ID.'
PRIVATE_KEY = 'Filepath to your Vonage private key.'
VONAGE_API_KEY = "Your Vonage API key."
VONAGE_API_SECRET = "Your Vonage API secret."
VONAGE_BRAND_NAME = "Your Vonage Brand Name"

In production, you should set and get them from environmental variables.

Usage

You can send a sonogram either by using the Sonogram API or by using the web app UI.

API

Here is how to send a songogram via API
1. Run webapp.py on your local machine.
2. Send a get request to http://127.0.0.1:5000/API/1.0.0/sonogram
Required parameters:
name: The name of the person sending the sonogram
artist_fname: The first name of the musician for the song you are sending.
artist_lname: The last name of the musician for the song you are sending.
song_name: The name of the song you are sending.
number: The number you are sending a sonogram to.

Example: http://127.0.0.1:5000/API/1.0.0/songogram?name=Cory+Althoff&artist_fname=Kanye+&artist_lname=West&song_name=Stronger&number=14328863554

Web App

Or:

1. Run webapp.py on your local machine.
   
2. Navigate to http://127.0.0.1:5000 in your web browser and use the UI.

License

This library is released under the MIT License.