README.md

Environment and Credentials Setup

1. Create a virtual environment

# Mac/Linux
python3 -m venv venv
. venv/bin/activate

# Windows
python -m venv venv
.\venv\Scripts\activate.bat

2. Install required packages

pip install -r requirements.txt

3. Change the filename of .env.example to .env and replace your-key-here with your corresponding API key, authtoken, etc. for each line. Make sure to not share this file with anyone or upload it to GitHub. You will need:
   1. An AssemblyAI API Key with funds added to access realtime transcription
   2. A Twilio account for your account SID as long as an API Key SID and secret
   3. A Twilio number. The value for TWILIO_NUMBER should be formatted as a sequence of digits with country code e.g. +12345678910.
   4. An ngrok account authtoken

Run the application

Execute python main.py or python3 main.py in the project directory to start the application. Then, call your Twilio phone number and begin speaking. You will see your speech transcribed in the console.