Community Data Science Workshops (Spring 2016)/Day 2 Projects/Wikipedia: Difference between revisions

From CommunityData
(started the page)
 
(Redirected page to Wikipedia CDSW Project)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[File:Wikipedia.png|right|250px]]
#redirect [[Wikipedia CDSW Project]]
__NOTOC__
 
In this project, we will explore a few ways to gather data using the Wikipedia API. Once we've done that, we will extend this to code to create our own datasets of Wikipedia edits or other data that we might be able to use to ask and answer questions in the final session.
 
== Goals ==
 
* Get set up to build datasets with the Wikipedia API
* Have fun collecting different types of data from Wikipedia
* Practice reading and extending other people's code
* Create a few collections of different types of data from Wikipedia that you can do research with in the final section
 
== Download and test the Wikipedia API 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 and tutorial]] and [[Community Data Science Workshops (Fall 2015)/Day 0 tutorial|Day 0 tutorial]]
 
(Estimated time: 10 minutes)
 
===Download the Wikipedia 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/wikipedia-data-examples.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, click on "Start", then "Computer" on Windows or open Finder and navigate to your Desktop directory if you are a Mac. Find <code>wikipedia-data-examples.zip</code> on your Desktop and double-click on it to "unzip" it. That will create a folder called <code>wikipedia-data-examples</code> containing several files.
 
===Test the Wikipedia API code===
 
<div style="background-color:#CEE7DA; width:80%; padding:1.2em;">
'''On Windows'''
 
Start up PowerShell and navigate to the <code>Desktop\wikipedia-data-examples</code> directory where the Wikipedia API code lives. For example, if the Wikipedia API project is at <code>C:\Users\'''YOURUSERNAME'''\Desktop\wikipedia-data-examples</code>,
 
cd C:\Users\'''YOURUSERNAME'''\Desktop\wikipedia-data-examples
 
</div>
<div style="background-color:#D8E8FF; width:80%; padding:1.2em;">
'''On Mac'''
 
Start a command prompt and navigate to the Desktop/wikipedia-data-examples directory where the Wikipedia API code lives. For example, if the Wikipedia API project is at <code>~/Desktop/wikipedia-data-examples</code>,
 
cd ~/Desktop/wikipedia-data-examples
 
</div>
 
This will change you into the Wikipedia example code directory. Running <code>ls</code> will show you the source code files in that directory. One of the files is "<code>wikipedia1-1.py</code>", which has a "<code>.py</code>" extension indicating that it is a Python script. Type:
 
python wikipedia1-1.py
 
at the command prompt to execute the <code>wikipedia1-1.py</code> Python script. Wait a little while while your computer connects to Wikipedia. You should see a series of data from Wikipedia run by on your screen. If you don't, let a staff member know.
 
== Example topics we might cover in the session ==
 
* explain [http://www.mediawiki.org/wiki/API:Main_page MediaWiki], exists on other wikis
* navigate to [http://en.wikipedia.org/w/api.php api page] and show the documentation, point out examples
* introduce the [https://en.wikipedia.org/wiki/Special:ApiSandbox API sandbox] as a tool for building queries
* looking at the images within a page http://en.wikipedia.org/w/api.php?action=query&titles=Seattle&prop=images&imlimit=20&format=jsonfm
* change the city with a custom URL
* edit count http://en.wikipedia.org/w/api.php?action=query&list=users&ususers=Benjamin_Mako_Hill|Jtmorgan|Sj|Koavf&usprop=editcount&format=jsonfm
* get the content of the main page http://en.wikipedia.org/w/api.php?format=json&action=query&titles=Main%20Page&prop=revisions&rvprop=content
 
== Resources ==
 
* [https://en.wikipedia.org/w/api.php?action=help&modules=query API documentation for the query module]
* [https://en.wikipedia.org/wiki/Special:ApiSandbox API Sandbox]
* [[Sample Wikipedia API queries]]
* [https://github.com/ben-zen/wikipedia-session The session lecture notes (in Markdown) and python sources.]
 
[[Category:Spring_2016 series]]

Latest revision as of 05:25, 23 April 2016