diff options
author | nico <nico@magicbroccoli.de> | 2019-05-30 02:49:38 +0200 |
---|---|---|
committer | nico <nico@magicbroccoli.de> | 2019-05-30 02:49:38 +0200 |
commit | 911450c72e83985a8ff8a7f1301184515f4aa351 (patch) | |
tree | 294e7128f8e874952278dfee0a156b2cd379ba6b | |
parent | 0d9f4147b08be59e2f6dc98efce24942985a590b (diff) |
readme config.py addition
* update README to explain config.py
-rw-r--r-- | README.md | 13 | ||||
-rw-r--r-- | config.py | 1 |
2 files changed, 13 insertions, 1 deletions
@@ -18,6 +18,19 @@ modules: ... ``` +### config.json +The `config.json` file is used to preserve date from possible updates to this script. `config.py` will load `config +.json` to extract the name, which is used to sign the report message with. In the future there might be other things +the `config.json` may contain. + +```json +$ cat config.json +{ + "name": "username" +} +``` + + ## usage main.py ``` usage: main.py [-h] [-in INFILE [INFILE ...]] [-d DOMAIN] [-r] @@ -15,5 +15,4 @@ except FileNotFoundError: class Config(object): - """extract secret key to use for the webserver""" name = config["name"] |