summaryrefslogtreecommitdiff
path: root/config.py
diff options
context:
space:
mode:
authorScott Gasch <[email protected]>2021-09-15 09:32:08 -0700
committerScott Gasch <[email protected]>2021-09-15 09:32:08 -0700
commit4c315e387f18010ba0b5661744ad3c792f21d2d1 (patch)
treea5657340bea356aa3aaf2c24b7f2be98bb4bc302 /config.py
parent83c1e0d04fe2e78963c8b508e8b7d0ae03bfcb16 (diff)
Adding doctests. Also added a logging filter.
Diffstat (limited to 'config.py')
-rw-r--r--config.py9
1 files changed, 6 insertions, 3 deletions
diff --git a/config.py b/config.py
index 574449f..1e690bc 100644
--- a/config.py
+++ b/config.py
@@ -1,7 +1,9 @@
#!/usr/bin/env python3
-"""Global configuration driven by commandline arguments (even across
-different modules). Usage:
+"""Global configuration driven by commandline arguments, environment variables
+and saved configuration files. This works across several modules.
+
+Usage:
module.py:
----------
@@ -36,7 +38,8 @@ different modules). Usage:
config.parse() # Very important, this must be invoked!
If you set this up and remember to invoke config.parse(), all commandline
- arguments will play nicely together:
+ arguments will play nicely together. This is done automatically for you
+ if you're using the bootstrap module's initialize wrapper.
% main.py -h
usage: main.py [-h]