docs(build): Update example files

This commit is contained in:
hygienic-books 2022-07-05 19:53:40 +02:00
parent fb26d472f2
commit 8297cf976e
5 changed files with 5 additions and 5 deletions

View File

@ -62,4 +62,4 @@ Above example of a Python project with all of Rich, `configparser` and `inflect`
├── requirements.txt
└── update-firewall-source.py
```
You can see real-life example file content over at [examples/rich-and-config](examples/rich-and-config). Cookiecutter has generated all necessary dependencies with pinned versions and a `update-firewall-source.py` script file to get you started.
You can see real-life example file content over at [examples/update-firewall-source](examples/update-firewall-source). Cookiecutter has generated all necessary dependencies with pinned versions and a `update-firewall-source.py` script file to get you started.

View File

@ -1,12 +1,12 @@
[DEFAULT]
self_name = rich-and-config
self_name = update-firewall-source
tmp_base_dir = /tmp/%(self_name)s
state_base_dir = /var/lib/%(self_name)s
state_files_dir = %(state_base_dir)s/state
state_file_retention = 50
state_file_name_prefix = state-
state_file_name_suffix = .log
rich_and_config_some_option = "http://localhost:8000/api/query"
update_firewall_source_some_option = "http://localhost:8000/api/query"
another_option = "first"
[this-is-a-section]

View File

@ -31,7 +31,7 @@ class CONST(object):
# an empty string. An example config.ini file may give a sane config example value here, removing that value
# still results in a valid file.
CFG_KNOWN_DEFAULTS = [
{"key": "self_name", "value": "rich-and-config", "empty_ok": False},
{"key": "self_name", "value": "update-firewall-source", "empty_ok": False},
{"key": "tmp_base_dir", "value": os.path.join(CFG_THIS_FILE_DIRNAME, "data/tmp/%(self_name)s"),
"empty_ok": False},
{"key": "state_base_dir", "value": os.path.join(CFG_THIS_FILE_DIRNAME, "data/var/lib/%(self_name)s"),
@ -40,7 +40,7 @@ class CONST(object):
{"key": "state_file_retention", "value": "50", "is_global": False, "empty_ok": True},
{"key": "state_file_name_prefix", "value": "state-", "is_global": False, "empty_ok": True},
{"key": "state_file_name_suffix", "value": ".log", "is_global": False, "empty_ok": True},
{"key": "rich_and_config_some_option", "value": "http://localhost:8000/api/query", "is_global": True,
{"key": "update_firewall_source_some_option", "value": "http://localhost:8000/api/query", "is_global": True,
"empty_ok": False},
{"key": "another_option", "value": "first", "is_global": True, "empty_ok": True}
]