Editing Yelp (CDSW)
From CommunityData
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 3: | Line 3: | ||
__NOTOC__ | __NOTOC__ | ||
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 | 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 of tweets. | ||
== Goals == | == Goals == | ||
| Line 14: | Line 14: | ||
== Prerequisite == | == Prerequisite == | ||
To participate in the Yelp afternoon session, you ''must'' have registered with Yelp as a developer before the session by following the [[Yelp | 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|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 == | == Download and test the Yelp project == | ||
| Line 24: | Line 24: | ||
===Download the Yelp 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: | * 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/yelp-api-cdsw.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>yelp-api-cdsw | * 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.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=== | ===Enter your API information=== | ||
* | <div style="background-color:#CEE7DA; width:80%; padding:1.2em;"> | ||
* Open up the file <code>yelp_authentication.py</code> in | '''On Windows''' | ||
* You will see four lines that include | |||
* | * Start your text editor (probably Notepad++ if you [[Windows text editor|installed it following our instructions last time]]). Navigate to the directory that contains Yelp API (probably something of the form <code>C:\Users\'''YOURUSERNAME'''\Desktop\yelp-api-cdsw</code>). | ||
</div> | |||
<div style="background-color:#D8E8FF; width:80%; padding:1.2em;"> | |||
'''On Mac''' | |||
* Start your text editor (probably TextWrangler if you installed it following [[OSX text editor|our instructions]]). Navigate to the directory that contains the Yelp API project (probably something of the form <code>~/Desktop/yelp-api-cdsw</code>). | |||
</div> | |||
* Open up the file <code>yelp_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 [[Yelp 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 Yelp API! | Once you have done this, your example programs are set up to use the Yelp API! | ||
| Line 38: | Line 51: | ||
===Test the Yelp API code=== | ===Test the Yelp API code=== | ||
# | <div style="background-color:#CEE7DA; width:80%; padding:1.2em;"> | ||
# navigate to yelp-api-cdsw | '''On Windows''' | ||
Start up PowerShell and navigate to the Desktop\yelp-api-cdsw directory where the Yelp API code lives. For example, if the Yelp API project is at <code>C:\Users\'''YOURUSERNAME'''\Desktop\yelp-api-cdsw</code>, | |||
cd C:\Users\'''YOURUSERNAME'''\Desktop\yelp-api-cdsw | |||
</div> | |||
<div style="background-color:#D8E8FF; width:80%; padding:1.2em;"> | |||
'''On Mac''' | |||
Start a command prompt and navigate to the Desktop/yelp-api-cdsw directory where the Yelp API code lives. For example, if the Yelp API project is at ~/Desktop/yelp-api-cdsw, | |||
cd ~/Desktop/yelp-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>yelp1.py</code>", which has a "<code>.py</code>" extension indicating that it is a Python script. Type: | |||
python yelp1.py | |||
at the command prompt to execute the <code>yelp.py</code> Python script. Wait a little while while your computer connects to Yelp. You should see a series of pieces of yelp data run by your screen. If you don't, let a mentor know. | |||
== Potential exercises == | == Potential exercises == | ||
== Congratulations!!!!== | |||
== Congratulations!== | |||
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. | 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: | [[Category:Fall_2015_series]] | ||
