simplified config take 2

Author: iromli

.gitignore

@@ -1,8 +1,6 @@
 .idea/workspace.xml
 venv
-test_users.db
-users.db
-users/config.py
+*.db
 *.py[cod]
 
 # C extensions

README.md

@@ -6,25 +6,40 @@ User Map
 
 A simple flask application for creating user community maps.
 
-First create a valid ``config.py`` e.g.
+By default, this app reads configuration from `users/config.py`.
+To override values set in default config, simply copy the contents
+of `users/config.py` and save it elsewhere.
 
-```
-cp users/config.py.prod users/config.py
-```
+    cp users/config.py /path/to/custom/config.py
+
+Then edit the custom config file, setting appropriate values as needed.
+
+To run in debug mode (which will also serve up static content),
+use the `-d` flag:
+
+    USERS_CONFIG=/path/to/custom/config.py python runserver.py -d
+
+Each config item is overridable through environment variable.
+For instance, if you want to suppress email delivery,
+simply set appropriate value:
 
-Then edit the config file, setting appropriate values as needed.
+    USERS_MAIL_SUPPRESS_SEND=True python runserver
 
-To run in debug mode (which will also serve up static content), use the -d
-flag.
+To run testcases:
 
-``python runserver.py -d``
+    USERS_CONFIG=/path/to/custom/config.py MAIL_SUPPRESS_SEND=True ./runtests.sh
 
+Collaboration
+-------------
 
-If running under pycharm, remember to edit the run configuration and add the
-``-d`` to the parameters.
+1. Fork this repo.
+2. Create a topic branch in your forked repo and start hacking.
+3. Run `runtests.sh`. Ensure all tests passed.
+4. Once it done, submit your pull request (PR) against upstream `develop` branch.
+5. Our maintainers will review your PR. If it's good — all tests passed and proposed feature is in our roadmap — your PR will be merged.
 
 Deployment using Docker
-=======================
+-----------------------
 
 If you are using docker, you can create a Docker image for this app easily as
 follows:
@@ -46,6 +61,6 @@ wget -O sources.list https://raw.github.com/timlinux/user_map/master/docker/hetz
 ```
 
 Authors
-=======
+-------
 
 Tim Sutton and Akbar Gumbira

requirements.txt

@@ -1,10 +1,13 @@
 Flask==0.10.1
-Jinja2==2.7.1
-MarkupSafe==0.18
-Werkzeug==0.9.4
-itsdangerous==0.23
-nose==1.3.0
+Flask-Mail==0.9.0
+Jinja2==2.7.3
+MarkupSafe==0.23
+Werkzeug==0.9.6
+blinker==1.3
+flask-appconfig==0.9.1
+itsdangerous==0.24
+nose==1.3.3
 pydns==2.3.6
+six==1.7.3
 validate-email==1.1
 wsgiref==0.1.2
-Flask-mail==0.9.0

runtests.sh

@@ -1,4 +1,10 @@
-#!/bin/bash
-source venv/bin/activate
+#!/usr/bin/env bash
+if [ -f venv/bin/activate ]; then
+    source venv/bin/activate
+fi
+
 nosetests -v --with-id  users
-deactivate
+
+if [ ! -z $(command -v deactivate) ]; then
+    deactivate
+fi

users/__init__.py

@@ -9,6 +9,7 @@
 
 from flask import Flask
 from flask_mail import Mail
+from flask.ext.appconfig import AppConfig
 
 
 def add_handler_once(logger, handler):
@@ -67,11 +68,25 @@ def setup_logger():
 
 APP = Flask(__name__)
 
-# Load configuration from ``users.config``.
-# This will raise ``ImportError`` if such module isn't exist.
-# Simply copy the contents of ``config.py.example`` file,
-# and save it into a file named ``config.py``.
-APP.config.from_object("users.config")
+#: Load configuration from any possible means.
+#: To override default configuration defined in ``users.config``,
+#: simply copy the contents of ``config.py`` file,
+#: and save it into a file.
+#:
+#: .. sourcecode:: sh
+#:
+#:     USERS_CONFIG=/path/to/config.py python runserver
+#:
+#: Another way of doing it is by setting environment variable for each
+#: config item.
+#:
+#: .. sourcecode:: sh
+#:
+#:     USERS_CONFIG=/path/to/config.py USERS_MAIL_SUPPRESS_SEND=True \
+#:         python runserver
+#:
+AppConfig(APP, default_settings="users.config")
+
 mail = Mail(APP)
 
 # backward-compat