Community Data Science Workshops (Fall 2015)/Day 2 projects/Wikipedia: Difference between revisions

From CommunityData
(→‎Resources: Added a link to my session notes.)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[File:Wikipedia.png|right|250px]]
[[File:Wikipedia.png|right|250px]]
__NOTOC__
__NOTOC__
== Building a Dataset using the Wikipedia API ==


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.
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 ===
== Goals ==


* Get set up to build datasets with the Wikipedia API
* Get set up to build datasets with the Wikipedia API
Line 17: Line 16:


(Estimated time: 10 minutes)
(Estimated time: 10 minutes)


===Download the Wikipedia API project===
===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
* 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, open Finder and navigate to your Desktop directory. 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.
* 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==


===Test the Wikipedia API code===


<div style="background-color:#CEE7DA; width:80%; padding:1.2em;">
<div style="background-color:#CEE7DA; width:80%; padding:1.2em;">
Line 50: Line 47:
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.
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 ==
* [[Community Data Science Workshops (Fall 2015)/Day 2 projects/Wikipedia/Windows setup|Windows]]
* [[Community Data Science Workshops (Fall 2015)/Day 2 projects/Wikipedia/OS X setup|OS X]]
 
=== Example topics we might cover in the lecture ===


* explain [http://www.mediawiki.org/wiki/API:Main_page MediaWiki], exists on other wikis
* explain [http://www.mediawiki.org/wiki/API:Main_page MediaWiki], exists on other wikis
Line 64: Line 57:
* 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
* 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 ===
== Resources ==
 
* [https://en.wikipedia.org/w/api.php?action=help&modules=query API documentation for the query module]
* [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]
* [https://en.wikipedia.org/wiki/Special:ApiSandbox API Sandbox]
* [[Sample API queries]]
* [[Sample Wikipedia API queries]]
* [https://github.com/ben-zen/wikipedia-session The session lecture notes (in Markdown) and python sources.]


[[Category:Fall_2015_series]]
[[Category:Fall 2015 series]]

Latest revision as of 06:55, 25 October 2015

Wikipedia.png


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[edit]

  • 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[edit]

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

(Estimated time: 10 minutes)

Download the Wikipedia API project[edit]

  • 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 wikipedia-data-examples.zip on your Desktop and double-click on it to "unzip" it. That will create a folder called wikipedia-data-examples containing several files.

Test the Wikipedia API code[edit]

On Windows

Start up PowerShell and navigate to the Desktop\wikipedia-data-examples directory where the Wikipedia API code lives. For example, if the Wikipedia API project is at C:\Users\YOURUSERNAME\Desktop\wikipedia-data-examples,

cd C:\Users\YOURUSERNAME\Desktop\wikipedia-data-examples

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 ~/Desktop/wikipedia-data-examples,

cd ~/Desktop/wikipedia-data-examples

This will change you into the Wikipedia example code directory. Running ls will show you the source code files in that directory. One of the files is "wikipedia1-1.py", which has a ".py" extension indicating that it is a Python script. Type:

python wikipedia1-1.py

at the command prompt to execute the wikipedia1-1.py 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[edit]

Resources[edit]