This content originally appeared on Twilio Blog and was authored by Mia Adjei
Weather apps are extremely helpful in a world where weather is becoming increasingly unpredictable. After all, even though you might be able to look out the window and see whether it's raining or not, you might not know what the temperature or UV index is without checking a website or app.
In this tutorial, you will learn how to build a little chatbot that can tell you the weather in your area or where you are planning to be, as well as remind you what you might want to bring along with you if you go outside.
Let's get started!
Prerequisites
- A free Twilio account. (If you register here, you'll receive $10 in Twilio credit when you upgrade to a paid account!)
- Python 3.6 or newer
- ngrok installed and set up on your machine. (Learn more about using ngrok in 2022 here.)
- A phone that can receive SMS
Set up a virtual environment and install dependencies
To start, open a new terminal window and navigate to where you would like to set up your project. Once you have done this, run the following commands to set up a new directory called weather-bot and change into the directory:
mkdir weather-bot
cd weather-bot
Next, you'll need to create a Python virtual environment where you can install the dependencies for this project. If you are working in a Mac or Unix environment, run the following commands:
python3 -m venv venv
source venv/bin/activate
If you are working in a Windows environment, run the commands below instead:
python -m venv venv
venv\Scripts\activate
For this project, you will be using the following Python modules:
- Flask, to create the web application
- python-dotenv, to import environment variables
- Twilio Python helper library, to work with the Twilio SMS API
Run the following command in your terminal to install these modules in your virtual environment:
pip install flask twilio python-dotenv
Configure a Twilio phone number
Next, you will need to configure a Twilio phone number with SMS capabilities for your chatbot to use.
If you do not already have a Twilio phone number that you want to use for this project, go to the Phone Numbers section in the Twilio Console and click the Buy a number button. On the Buy a Number screen, select your country and make sure SMS is selected in the capabilities field.
Then, click the Search button, and when you see a number you like, click the Buy button to purchase it. Once you do this, you'll have your own Twilio phone number!
Get a Weatherstack API key
Now that you have your phone number, it's time to get an API key so you can use the Weatherstack API to get information about weather around the world. Navigate to their website and sign up for a free account to start using the API.
Once you sign up, you will see your API key on your dashboard.
Inside your weather-bot directory, create a new file called .env. This is where you will store the environment variables for your project. In the file, paste in the following placeholder:
WEATHERSTACK_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Then replace the placeholder value with the Weatherstack API key you just created.
It’s very important to keep these private credentials secure and out of version control, so if you are using Git, create a .gitignore file at the root of your project. Here you can list the files and directories that you want git to ignore from being tracked or committed. Open .gitignore in your code editor and add the .env file, as shown below:
.env
Create a Flask service for the bot's logic
Now it's time to build the main part of the project.
This Flask service will only have one endpoint: /weather. When a user sends their location in an SMS message to your Twilio phone number, a function called weather() will call the Weatherstack API to find out the weather for that location, and then offer some helpful advice about what to bring if there is precipitation (rain, snow, drizzle, hail, etc), if the temperature is low, or if the UV index is high.
Create a new file in the weather-bot directory called app.py. In the file, add the following code:
import os
import requests
from flask import Flask, request
from dotenv import load_dotenv
from twilio.twiml.messaging_response import MessagingResponse
load_dotenv()
WEATHERSTACK_API_KEY = os.environ.get('WEATHERSTACK_API_KEY')
app = Flask(__name__)
@app.route('/weather', methods=['POST'])
def weather():
# Add logic here
if __name__ == '__main__':
app.run()
With this code, you've created the outline of your application, importing the required modules at the top of the file, loading the environment variable, and then creating a new Flask application with the /weather endpoint.
Inside the weather() function, the first thing you will need to do is get the user's location from their text message. The Weatherstack API allows users to use the query parameter to pass in location information in a variety of ways — by location name, zip code, coordinates, or IP address. In our application, we can take this information from the incoming SMS message, and then include it in our parameters dict, along with the API key and the units of measure in which we would like to display the data.
While in this tutorial, we retrieve temperature data in Fahrenheit, if you would rather use metric units, you can change the units param from f to m. Learn more about the Units Parameter here.
Once you have the params ready, you can call the Weatherstack API to get weather data for the user's location. From the response, you can pull out the relevant data you would like to display to the user. In this example, we are using location, temperature, description, precipitation, and UV index data.
Once you have the data, you can use it to offer advice to the user and append those messages to the response that will be sent in the return SMS. In this example, if there is precipitation, we remind the user to bring an umbrella. If it is cold outside (less than 45 degrees Fahrenheit), then we remind them to wear a coat. And if the UV index is higher than 2, we tell the user to wear some sunscreen to protect themselves from the sun. Once the weather data and advice messages have been formatted nicely, we return the message to the user as an SMS message.
Now that you know what this code should achieve, update the weather() function with the following code:
@app.route('/weather', methods=['POST'])
def weather():
# Get the user's location from the incoming message
location = request.values.get('Body', '')
resp = MessagingResponse()
msg = resp.message()
# https://weatherstack.com/documentation
# Change 'units' to 'm' for metric units
params = {
'access_key': WEATHERSTACK_API_KEY,
'query': location,
'units': 'f',
}
api_result = requests.get('http://api.weatherstack.com/current', params)
if api_result.status_code == 200:
data = api_result.json()
if data.get('error'):
msg.body('Sorry, I am unable to get weather data for that location.')
else:
weather_location = data['location']['name']
temperature = data['current']['temperature']
description = data['current']['weather_descriptions'][0]
precipitation = data['current']['precip']
uv_index = data['current']['uv_index']
formatted_response = f'{weather_location}: {temperature}°, {description}. '
if precipitation > 0:
formatted_response += 'Bring an umbrella! ☂️ '
if temperature < 45:
formatted_response += 'Wear a coat! 🧥 '
if uv_index > 45:
formatted_response += 'Wear some sunscreen! ☀️ '
msg.body(formatted_response)
else:
msg.body('Sorry, I am unable to get weather data for that location.')
return str(resp)
Now that you have the code you need, it's time to run the Flask server. Return to the command line and run the following command:
flask run
This will start the server on port 5000 on your local machine. To make this service reachable online, we can use ngrok to create a URL that forwards requests to our localhost:5000.
Open a new terminal window and start ngrok with the following command:
ngrok http 5000
The output from ngrok will be similar to the following:
Take note of the URL next to Forwarding — you will need it in order to configure a webhook that will let your bot respond to SMS messages.
Configure the webhook and test the bot
Return to the Phone Numbers section of the Twilio Console and scroll down to the Messaging section. Copy the forwarding URL from ngrok, and paste it into the Webhook field under A MESSAGE COMES IN. Then, add /weather to the end of this URL, since /weather is the endpoint for our chatbot. Make sure the request method is set to HTTP POST.
Click the Save button to save your changes. Now, every time someone sends a text message to your Twilio number, your weather bot will receive the request at the /weather endpoint and be able to use the location information in the incoming message to fetch weather data and return information and advice to the user.
Try it out! Text your city name, zip code, or coordinates to your Twilio phone number, and see what the weather is around you. You can even try it out with other cities around the world.
What's next for building a weather bot?
Now that you have built this SMS weather bot, you can customize or expand on it with other data or add even more weather-related advice to share with the user. Additionally, if you are interested in upgrading your Weatherstack API access, you can even get historical and forecast data that may be interesting to include in your weather bot application.
I can't wait to see what you build!
Mia Adjei is a Software Engineer for Technical Content at Twilio. They love to help developers build out new project ideas and discover aha moments. Mia can be reached at madjei [at] twilio.com.
This content originally appeared on Twilio Blog and was authored by Mia Adjei
Mia Adjei | Sciencx (2022-06-30T23:07:44+00:00) Build a Weather Chatbot with Twilio SMS, Python, and Flask. Retrieved from https://www.scien.cx/2022/06/30/build-a-weather-chatbot-with-twilio-sms-python-and-flask/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.