Yelp (CDSW): Difference between revisions

Latest revision as of 06:23, 31 January 2020

In this project, we will explore a few ways to gather data using the Yelp API. Once we've done that, we will extend the example code to create our own dataset from Yelp.

Goals[edit]

Get set up to build datasets with the Yelp API
Have fun collecting different types of data from Yelp using a variety of ways to search
Practice reading and extending other people's code
Create a few collections of Yelp data to use in your projects

Prerequisite[edit]

To participate in the Yelp afternoon session, you must have registered with Yelp as a developer before the session by following the Yelp authentication setup instructions. If you did not do this, or if you tried but did not succeed, please attend one of the other two sessions instead.

Download and test the Yelp project[edit]

If you are confused by these steps, go back and refresh your memory with the Day 0 setup instructions

(Estimated time: 10 minutes)

Download the Yelp API project[edit]

Right click the following file, click "Save Target as..." or "Save link as...", and save it to your Desktop directory: https://github.com/CommunityDataScienceCollective/yelp-api-cdsw/archive/master.zip
The ".zip" extension on the above file indicates that it is a compressed Zip archive. We need to "extract" its contents. To do this on Windows, click on "Start", then "Computer". If you are a Mac, open Finder and navigate to your Desktop directory. Find yelp-api-cdsw-master.zip on your Desktop and double-click on it to "unzip" it. That will create a folder called yelp-api-cdsw containing several files.

Enter your API information[edit]

Open Jupyter and navigate to the directory that contains Yelp API (probably something of the form C:\Users\YOURUSERNAME\Desktop\yelp-api-cdsw on Windows and ~/Desktop/yelp-api-cdsw on Mac OSX.
Open up the file yelp_authentication.py in Jupyter.
You will see four lines that include one variable "APIkey".
Find the API key you created and wrote-down in "Create App" when you followed the Yelp authentication setup. Change the string that says "CHANGE ME" into a string that includes the key you downloaded. Remember that since this is a string, we need to include quotations marks around them.

Once you have done this, your example programs are set up to use the Yelp API!

Test the Yelp API code[edit]

start your Jupyter notebook
navigate to yelp-api-cdsw
click on yelp1_business_search.ipynb
run the script

Potential exercises[edit]

Search in different places (your home town?)
Change your search in some way described in the API documentation (e.g., use a category filter)
Instead of rating information, print out phone numbers... but what will we do if we don't have phone numbers?
Open a file and save the answers to a file instead of just printing them out
How many shops can you get information on at a time? What happens if you ask for more? How many do you get then?
What is the highest rated falafel place in Seattle?
What is the highest rated business in Seattle?
Of all the highly rated restaurants you can see with an API search, how many have less than 100 reviews?
Make an interactive version that prompts users for input.

Congratulations![edit]

You now know how to capture data from Yelp that you can use in your research! Next workshop we'll play with some fun analytical tools.

@@ Line 1: / Line 1: @@
-[[File:Twitter.png|right|260px]]
+[[File:Yelp Logo.svg|right|300px]]
 __NOTOC__
-In this project, we will explore a few ways to gather data using the Twitter API. Once we've done that, we will extend the example code to create our own dataset of tweets. In the final workshop (Nov. 5), we will ask and answer questions with the data we've collected.
+In this project, we will explore a few ways to gather data using the Yelp API. Once we've done that, we will extend the example code to create our own dataset from Yelp.
 == Goals ==
-* Get set up to build datasets with the Twitter API
+* Get set up to build datasets with the Yelp API
-* Have fun collecting different types of tweets using a variety of ways to search
+* Have fun collecting different types of data from Yelp using a variety of ways to search
 * Practice reading and extending other people's code
-* Create a few collections of Tweets to use in your projects
+* Create a few collections of Yelp data to use in your projects
 == Prerequisite ==
-To participate in the Twitter afternoon session, you ''must'' have registered with Twitter as a developer before the session by following the [[Twitter authentication setup|Twitter authentication setup instructions]]. If you did not do this, or if you tried but did not succeed, please attend one of the other two sessions instead.
+To participate in the Yelp afternoon session, you ''must'' have registered with Yelp as a developer before the session by following the [[Yelp API Key|Yelp authentication setup instructions]]. If you did not do this, or if you tried but did not succeed, please attend one of the other two sessions instead.
-== Download and test the Twitter project ==
+== Download and test the Yelp project ==
 If you are confused by these steps, go back and refresh your memory with the [[Community_Data_Science_Workshops_(Fall_2015)/Day_0_setup_and_tutorial|Day 0 setup instructions]]
@@ Line 22: / Line 22: @@
 (Estimated time: 10 minutes)
-===Download the Twitter API project===
+===Download the Yelp API project===
-* Right click the following file, click "Save Target as..." or "Save link as...", and save it to your Desktop directory: http://mako.cc/teaching/2015/cdsw-autumn/twitter-api-cdsw.zip
+* Right click the following file, click "Save Target as..." or "Save link as...", and save it to your Desktop directory: https://github.com/CommunityDataScienceCollective/yelp-api-cdsw/archive/master.zip
-* The ".zip" extension on the above file indicates that it is a compressed Zip archive. We need to "extract" its contents. To do this on Windows, click on "Start", then "Computer".  If you are a Mac, open Finder and navigate to your Desktop directory. Find <code>twitter-api-cdsw.zip</code> on your Desktop and double-click on it to "unzip" it. That will create a folder called <code>twitter-api-cdsw</code> containing several files.
+* The ".zip" extension on the above file indicates that it is a compressed Zip archive. We need to "extract" its contents. To do this on Windows, click on "Start", then "Computer".  If you are a Mac, open Finder and navigate to your Desktop directory. Find <code>yelp-api-cdsw-master.zip</code> on your Desktop and double-click on it to "unzip" it. That will create a folder called <code>yelp-api-cdsw</code> containing several files.
 ===Enter your API information===
-<div style="background-color:#CEE7DA; width:80%; padding:1.2em;">
+* Open Jupyter and navigate to the directory that contains Yelp API (probably something of the form <code>C:\Users\'''YOURUSERNAME'''\Desktop\yelp-api-cdsw</code> on Windows and  <code>~/Desktop/yelp-api-cdsw</code> on Mac OSX.
-'''On Windows'''
+* Open up the file <code>yelp_authentication.py</code> in Jupyter.
+* You will see four lines that include one variable "APIkey".
+* Find the API key you created and wrote-down in "Create App" when you followed the [[Yelp authentication setup]]. Change the string that says "CHANGE ME" into a string that includes the key you downloaded. Remember that since this is a string, we need to include quotations marks around them.
-* Start your text editor (probably Notepad++ if you [[Windows text editor|installed it following our instructions last time]]). Navigate to the directory that contains Twitter API (probably something of the form <code>C:\Users\'''YOURUSERNAME'''\Desktop\twitter-api-cdsw</code>).
+Once you have done this, your example programs are set up to use the Yelp API!
-</div>
+===Test the Yelp API code===
-<div style="background-color:#D8E8FF; width:80%; padding:1.2em;">
+# start your Jupyter notebook
-'''On Mac'''
+# navigate to yelp-api-cdsw
+# click on yelp1_business_search.ipynb
-* Start your text editor (probably TextWrangler if you installed it following [[OSX text editor|our instructions]]). Navigate to the directory that contains the Twitter API project (probably something of the form <code>~/Desktop/twitter-api-cdsw</code>).
+# run the script
-</div>
-* Open up the file <code>twitter_authentication.py</code> in your text editor.
-* You will see four lines that include four variables in ALL CAPITALS that are being assigned, in the normal ways we learned about last session, to strings. At the moment, all of the strings say CHANGE_ME.
-* Go find the four keys, tokens, and secrets you created and wrote-down when you followed the [[Community Data Science Workshops/Twitter authentication setup|Twitter authentication setup]]. Change every string that says CHANGE_ME into a string that includes the key, token, or secret you downloaded. Remember that since these are strings, we need to include quotations marks around them. Also make sure that you match up the right keys and tokens with the right variables.
-Once you have done this, your example programs are set up to use the Twitter API!
-===Test the Twitter API code===
-<div style="background-color:#CEE7DA; width:80%; padding:1.2em;">
-'''On Windows'''
-Start up PowerShell and navigate to the Desktop\twitter-api-cdsw directory where the Twitter API code lives. For example, if the Twitter API project is at <code>C:\Users\'''YOURUSERNAME'''\Desktop\twitter-api-cdsw</code>,
- cd C:\Users\'''YOURUSERNAME'''\Desktop\twitter-api-cdsw
-</div>
-<div style="background-color:#D8E8FF; width:80%; padding:1.2em;">
-'''On Mac'''
-Start a command prompt and navigate to the Desktop/twitter-api-cdsw directory where the Twitter API code lives. For example, if the Twitter API project is at ~/Desktop/twitter-api-cdsw,
- cd ~/Desktop/twitter-api-cdsw
-</div>
-This will change you into the right directory. <code>ls</code>
-will show you the source code files in that directory. One of the files is "<code>twitter1.py</code>", which has a "<code>.py</code>" extension indicating that it is a Python script. Type:
- python twitter1.py
-at the command prompt to execute the <code>twitter1.py</code> Python script. Wait a little while while your computer connects to Twitter. You should see a series of tweets run by your screen. If you don't, let a mentor know.
 == Potential exercises ==
-'''Who are my followers?'''
+# Search in different places (your home town?)
+# Change your search in some way described in the API documentation (e.g., use a category filter)
-# Alter code example 2 (twitter2.py) to get your followers.
+# Instead of rating information, print out phone numbers... but what will we do if we don't have phone numbers?
-# For each of your followers, get *their* followers (investigate time.sleep to throttle your computation)
+# Open a file and save the answers to a file instead of just printing them out
-# Identify the follower you have that also follows the most of your followers.
+# How many shops can you get information on at a time? What happens if you ask for more? How many do you get then?
-# How many handles follow you but none of your followers?
+# What is the highest rated falafel place in Seattle?
-# Repeat this for people you follow, rather than that follow you.
+# What is the highest rated business in Seattle?
+# Of all the highly rated restaurants you can see with an API search, how many have less than 100 reviews?
-'''Topics and Trends'''
+# Make an interactive version that prompts users for input.
-# Alter code example 3 (twitter3.py) to produce a list of 1000 tweets about a topic.
-# Look at those tweets. How does twitter interpret a two word query like "data science"
-# Eliminate retweets [hint: look at the tweet object!   https://dev.twitter.com/overview/api/tweets]
-# For each tweet original tweet, list the number of times you see it retweeted.
-# Get a list of the URLs that are associated with your topic.
-'''Geolocation'''
-# Alter the streaming algorithm to include a "locations" filter. You need to use the order sw_lng, sw_lat, ne_lng, ne_lat for the four coordinates.  (Recall Control C will stop an active process like the stream.)
-# What are people tweeting about in Times Square today? (Bonus points: set up a bounding box around TS and around NYC as a whole.)
-# Can you find words that are more likely to appear in TS?
-# UW is playing Arizona in football today. Set up a bounding box around the Arizona stadium and around UW. Can you identify tweets about football? Who tweets more about the game? (you can use <code>d = api.search(geocode='37.781157,-122.398720,1mi')</code> to do a static geo search.)
-== Congratulations!!!!==
+== Congratulations!==
-You now know how to capture data from Twitter that you can use in your research!!! Next workshop we'll play with some fun analytical tools. In the meantime, here are [[Twitter words of warning|a few words of caution about using Twitter data for science]].
+You now know how to capture data from Yelp that you can use in your research! Next workshop we'll play with some fun analytical tools.
-[[Category:Fall_2015_series]]
+[[Category:CDSW]]