Moved config.ini.example to config.defaults.ini

 - see #43
 - can fix #63

Author: sedrubal

FabLabKasse/cashPayment/client/PaymentDevicesManager.py

@@ -29,6 +29,7 @@
 from ConfigParser import ConfigParser
 import codecs
 
+
 class PaymentDevicesManager(object):
 
     def __init__(self, cfg):
@@ -157,7 +158,7 @@ def canPayout(self):
             return None
         if self.mode == "canPayout":
             # commands already sent
-            if not None in self.canPayoutAmounts:
+            if None not in self.canPayoutAmounts:
                 # all devices sent replies
                 canPayoutAmounts = self.canPayoutAmounts
                 self.canPayoutAmounts = None  # invalidate cache
@@ -232,7 +233,7 @@ def _updatePayinAmounts(self):
         """
         for d in self.devices:
             maximum = self.maximumPayin - self.getCurrentAmount()
-            if d.getCurrentAmount() != None:
+            if d.getCurrentAmount() is not None:
                 maximum += d.getCurrentAmount()
             d.updateAcceptValue(maximum)
 
@@ -242,7 +243,7 @@ def getCurrentAmount(self):
         """
         totalSum = self.finishedAmount
         for d in self.devices:
-            if d.getCurrentAmount() != None:
+            if d.getCurrentAmount() is not None:
                 totalSum += d.getCurrentAmount()
         return totalSum
 
@@ -346,6 +347,7 @@ def getFinalAmount(self):
         self.mode = "idle"
         return ret
 
+
 class PaymentDevicesManagerTest(unittest.TestCase):
     """ Test PaymentDevicesManager
     """
@@ -355,7 +357,7 @@ def test_canPayout_with_one_random_datapoint_on_example_server(self):
         """
         # probably hacky, should be improved
         cfg = ConfigParser()
-        cfg.readfp(codecs.open('./FabLabKasse/config.ini.example', 'r', 'utf8'))
+        cfg.readfp(codecs.open('./FabLabKasse/config.defaults.ini', 'r', 'utf8'))
 
         for _ in range(0, 9):
             history = []
@@ -406,6 +408,7 @@ def myRandInt(n):  # 0 ... n, with a finite >0 probability for both endpoints
             self.assertTrue(requested - canRemain <= paidOut <= requested, msg=msg)
             self.assertTrue(paidOut >= 0, msg=msg)
 
+
 def demo():
     """Simple demonstration using two exampleServer devices"""
     # TODO this code seems to be broken, maybe adapt code from unittest or discard

FabLabKasse/config.ini.example renamed to FabLabKasse/config.defaults.ini

@@ -1,4 +1,7 @@
 [general]
+; support mail will be displayed when error occur
+support_mail = [email protected]
+
 ; Path to sqlite3 file
 db_file = development.sqlite3
 

FabLabKasse/scriptHelper.py

@@ -22,6 +22,7 @@
 import signal
 import logging
 import logging.handlers
+import os
 import sys
 import portalocker
 import sqlite3
@@ -92,9 +93,17 @@ def myNewExceptionHook(exctype, value, tb):
 def getConfig(path="./"):
     cfg = ConfigParser()
     try:
-        cfg.readfp(codecs.open(path + 'config.ini', 'r', 'utf8'))
+        cfg.readfp(codecs.open(path + 'config.defaults.ini', 'r', 'utf8'))  # read default configs
     except IOError:
-        raise Exception("Cannot open configuration file. If you want to try the program and do not have a config, start ./run.py --example or just copy config.ini.example to config.ini")
+        raise Exception("Cannot open config.defaults.ini.")
+    if os.path.isfile(path + 'config.ini'):
+        try:
+            cfg.readfp(codecs.open(path + 'config.ini', 'r', 'utf8'))
+        except IOError:
+            raise Exception("Cannot open config.ini.")
+    else:
+        print("[!] 'config.ini' not found. Using 'config.defaults.ini'"
+              "    copy 'config.defaults.ini' to 'config.ini' to adapt the deafault config!")
     return cfg
 
 

INSTALLING

@@ -72,7 +72,7 @@ Modem-Manager interferes with the serial port. It is highly recommended to remov
 -----------------
 
     cd FabLabKasse/
-    cp config.ini.example config.ini
+    cp config.defaults.ini config.ini
     # now edit config.ini file
 
 Please use database name "production" for the real terminal, and something else for tests and development!

README.cashPayment

@@ -122,7 +122,7 @@ Dies damit `./cash move muenz.manual muenz.tubeN /123x50c/` zurückgefüllt
 Configuration 
 -------------
 
-see config.ini.example
+see config.defaults.ini
 
 order of devices is important! Payout is in ascending order of the device number. Payin is in parallel.
 Sort the devices from large to small denominations. (banknote payout first)

TODO

@@ -4,7 +4,7 @@ TODO
 Needed testing for FAU FabLab
 -----------------------------
 
-    cp config.ini.example config.ini
+    cp config.defaults.ini config.ini
 
 edit config.ini:
  - set [backend] backend=legacy_offline_kassenbuch

run.py

@@ -49,6 +49,8 @@ def main():
     currentDir = os.getcwd() + "/"
     os.chdir(currentDir + "/FabLabKasse/")
 
+    # TODO restructure this: simply provide a --config-file parameter but
+    # always load config.defaults.ini first and the the users config
     if "--example" in sys.argv:
         # load example config
         # test that there is no config.ini yet
@@ -59,11 +61,10 @@ def main():
                 time.sleep(2)
         else:
             print("loading example configuration file. edit FabLabKasse/config.ini to change. You do not need the --example parameter later.")
-            shutil.copyfile("config.ini.example", "config.ini")
+            shutil.copyfile("config.defaults.ini", "config.ini")
     if "--only-load-config" in sys.argv:
-         # the Vagrant VM provisioning script uses this to copy a default config before the first start.
-         sys.exit(0)
-
+        # the Vagrant VM provisioning script uses this to copy a default config before the first start.
+        sys.exit(0)
 
     os.chdir(currentDir + "/FabLabKasse/UI/")
     subprocess.call("./compile_all.py")