Create requirements.txt for Python setup and document it in README

nofeet · Nov 15, 2012 · 8db22fe · 8db22fe
1 parent 8bb869e
commit 8db22fe
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -18,9 +18,28 @@ But this is really just a way for me to learn and play around with some cool tec
 * Python 2.7
 * Node 0.6.19+
 
+#### Optional ####
 
-### Set Up ###
+* `python-dev` package for simplejson speedups
 
-1. pip install mwclient
+### Python Wikipedia Scraper ###
 
-**more TBD**
+#### Set Up ####
+
+From root of repo--
+
+    pip install -r requirements.txt
+
+To run scraper to generate `./birthdays.json`--
+
+    cd fetch_data
+    python wikiparse.py
+
+To run tests--
+
+    cd fetch_data
+    python test_wikiparse.py
+
+#### Server ####
+
+**TBD**
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+mwclient==0.6.5
+simplejson==2.6.2