Cleanup & documentation

README.md

@@ -24,20 +24,21 @@ Configuration
 
 Copy whyattend/config.py to local_config.py and adjust the settings.
 Put your clan's logo into whyattend/static/img/clanicons.
+Replace whyattend/static/img/header.jpg with an image of your choice.
 
 After deployment, the initial database schema should be generated by
-opening /createdb in a browser, while app.config['DEBUG'] is set to True.
+opening /createdb?API_KEY=<configured API KEY> in a browser.
 
 The clan member roles can be synchronized with Wargaming's server by
-opening /sync-players/<clanid>/?API_KEY=<config.API_KEY>
+opening /sync-players/<clanid>/?API_KEY=<configured API KEY>
 
 config.API_KEY should be set to something random and secret, so only you
 can trigger the synchronization.
 
 This can be automated by a cron script, e.g:
 
     > #!/bin/bash
-    > # Clan WHY
+    > # Synchronize WHY members
     > curl "http://myserver.com/sync-players/500014725?API_KEY=supersecret"
 
 

whyattend/config.py

@@ -1,4 +1,7 @@
-""" Configuration settings.
+"""
+    Application Configuration
+    ~~~~~~~~~~~~~~~~~~~~~~~~~
+
     This file should be used as a template and overview
     of all available options. Put your local deployment
     settings into local_config.py, which overrides these

whyattend/model.py

@@ -1,5 +1,6 @@
 """
     Database mapping
+    ~~~~~~~~~~~~~~~~
 """
 
 import pickle
@@ -213,7 +214,9 @@ def get_representative_battle(self):
 class Replay(db.Model):
     __tablename__ = 'replay'
     id = db.Column(db.Integer, primary_key=True)
+    # The data returned by replays.parse_replay as Python pickle
     replay_pickle = db.Column(db.Binary)
+    # The replay file
     replay_blob = db.Column(db.Binary)
 
     def __init__(self, replay_blob, replay_pickle):

whyattend/replays.py

@@ -1,4 +1,7 @@
 """
+    Replay Parsing
+    ~~~~~~~~~~~~~~
+
     World of Tanks replay parsing and information extraction
 """
 

whyattend/util.py

@@ -1,5 +1,6 @@
 """
     Utility classes
+    ~~~~~~~~~~~~~~~
 """