doorpi/status/requirements_lib/req_config.py
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import logging
logger = logging.getLogger(__name__)
logger.debug("%s loaded", __name__)
REQUIREMENT = dict(
fulfilled_with_one = True,
text_description = '',
events = [
#dict( name = 'Vorlage', description = ''),
],
configuration = [
#dict( section = 'DoorPi', key = 'eventlog', type = 'string', default = '!BASEPATH!/conf/eventlog.db', mandatory = False, description = 'Ablageort der SQLLite Datenbank für den Event-Handler.'),
],
libraries = dict(
ConfigParser = dict(
text_warning = '',
text_description = 'Das Config-Modul wird benötigt um alle Einstellungen in einer Datei abspeichern und später wieder laden zu können.',
text_installation = 'Eine Installation ist nicht nötig, da es sich hierbei um eine Python-Standard-Modul handelt.',
auto_install = False,
text_test = 'Der Status kann gestestet werden, in dem im Python-Interpreter <code>import ConfigParser</code> eingeben wird.',
text_configuration = '''Eine Konfiguration als Eintrag in der Konfigurationsdatei macht logischerweise keinen Sinn.
Deshalb kann die zu nutzende Config-Datei als Parameter (--configfile) beim DoorPi Start mitgegeben werden. Beispiel:
<code>sudo /home/DoorPi/doorpi/main.py --configfile /home/DoorPi/conf/doorpi.ini</code>
Wenn der Parameter wegelassen wird, sucht der ConfigParser automatisch nach folgenden Dateien (wobei !BASEPATH! das Home-Verzeichnis von DoorPi ist)
<ol>
<li>!BASEPATH!/conf/doorpi.ini</li>
<li>!BASEPATH!/conf/doorpi.cfg</li>
<li>!BASEPATH!\conf\doorpi.ini</li>
<li>!BASEPATH!\conf\doorpi.cfg</li>
</ol>
Sollte keine Datei vorhanden sein, so wird mit default-Werten versucht DoorPi zum Laufen zu bringen und die Config-Datei als erster möglicher Eintrag abzuspeichern.
''',
configuration = [
#dict( section = 'DoorPi', key = 'eventlog', type = 'string', default = '!BASEPATH!/conf/eventlog.db', mandatory = False, description = 'Ablageort der SQLLite Datenbank für den Event-Handler.')
],
text_links = {
'docs.python.org': 'https://docs.python.org/2.7/library/configparser.html'
}
)
)
)