Update config, dev files, and docs

Author: colbygk

README.md

@@ -2,18 +2,43 @@
 
 This repo contains all of the challenges from [**r/dailyprogrammer**](http://reddit.com/r/dailyprogrammer) and also scripts used to pull challenges from the subreddit 3 times per week and to cleanup directories & remove unnecessary posts.
 
-## How to use
-The script can also be run via the command line by running `./post_challenges <number_of_challenges>`
+## Requirements
+
+- Python 3
+  - praw
+  - pprint
 
-### Required Modules:
-- praw
-- subprocess
-- re
-- os
-- pprint
+## Installation
 
-**post-challenges.py runs on Python 3.x**
+  ```bash
+  $ pip3 install -r etc/requirements.txt
+  ```
+
+## How to use
 
+The script can also be run via the command line by running `./post-challenges.py <number_of_challenges>`
+It will look for a copy of `praw.ini`, an example is in `etc/praw.ini.example`
+
+You may wish to run this in a temporary directory, to avoid adding folders directly to the top directory of the repo. Move the various levels of challenges into their respective end points.
+
+### Example full run
+
+  ```bash
+  $ cd DailyProgrammerChallenges
+  $ mkdir tmp
+  $ cp etc/praw.ini.example tmp/praw.ini
+  $ cd tmp
+  # Edit praw.ini with the correct info
+  $ ../post-challenges.py
+  # Take a look at what was downloaded for any 'problems'
+  $ mv *Easy* "Easy Challenges/."
+  $ mv *Intermediate* "Intermediate Challenges/."
+  $ mv *Hard* "Hard Challenges/."
+  $ cd ..
+  $ ./transform.py
+  ```
+
+  Examine the changes that `transform.py` performed and check that they seem okay.
 
 ## Challenges & Solutions
 

etc/praw.ini.example

@@ -0,0 +1,12 @@
+[DEFAULT]
+client_id=CHANGE ME
+client_secret=CHANGE ME
+password=CHANGE ME
+username=CHANGE ME
+
+# The URL prefix for OAuth-related requests.
+oauth_url=https://oauth.reddit.com
+
+# The URL prefix for regular requests.
+reddit_url=https://www.reddit.com
+

transform.py

@@ -20,10 +20,10 @@ def update_challenge_dir_name(oldName, difficulty):
     suspects that it would fail a valid transformation.'''
 
     # Find the challenge number:
-    #  tokens, delimited by ' '
-    #  find the first token that has one number embedded within
-    #   This should be the challenge number
-    #     This should avoid other strings with multiple numbers e.g. '[2016-05-20]'
+    # tokens, delimited by ' '
+    # find the first token that has one number embedded within
+    # This should be the challenge number
+    # This should avoid other strings with multiple numbers e.g. '[2016-05-20]'
     tokens = oldName.split()
 
     currNum = ''
@@ -41,14 +41,14 @@ def update_challenge_dir_name(oldName, difficulty):
         n = n - 1
 
     # No correct looking number found, or, it appears that the
-    #   number returned already appears to be in canonical form
+    # number returned already appears to be in canonical form
     if (n == 0 or currNum[0] == '0'):
         return oldName
 
     # Found a likely looking number
-    #   tokens now possess' the remaining title
-    #   a_token now has the original and possible multiple iteration number
-    #     such as 166b
+    # tokens now possess' the remaining title
+    # a_token now has the original and possible multiple iteration number
+    # such as 166b
     i = re.findall(r'\S*' + re.escape(currNum) + '(\S*)$', a_token)
     newNum = ' ' + '0'*(4-n) + currNum + (i.pop() if (len(i) > 0) else ' ') + ' '