zavage-software/app_skellington
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

referenced ConfigObj documentation links

Browse Source
This commit is contained in:
Mathew Guest 2020-03-11 23:18:51 -06:00
parent f74b901765
commit 56131511cb
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -15,14 +15,18 @@ Principles:
Application Configuration
-------------------------
Site configurations are supported through configobj. There is a config.spec
Site configurations are supported through ConfigObj. There is a config.spec
in the src directory which is a validation file; it contains the accepted
parameter names, types, and limits for configurable options in the
application which is built on app_skellington. The format is multi-level .ini syntax.
See the configobj documentation for more information.
Reference the ConfigObj documentation for config.ini and config.spec
format. See:
Site configuration files (config.ini) are created if they don't exit. The
* https://configobj.readthedocs.io/en/latest/configobj.html#the-config-file-format
* https://configobj.readthedocs.io/en/latest/configobj.html#validation
Config files (config.ini) are created if they don't exist. The
file always contains the full specification of parameters; i.e. even default
parameters are added into the config file.
@ -42,7 +46,7 @@ Application configuration can be overridden ad-hoc through the --config <filenam
argument.
Debug - Turn on Logging
---------------------------
-----------------------
Set 'APPSKELLINGTON_ENABLE_LOGGING' environment variable to any value which turns
on AppSkellington-level logging. For example,