Skip to content
Snippets Groups Projects
Unverified Commit a0dba611 authored by Jon Crall's avatar Jon Crall
Browse files

doc: update readme

parent df4f33c3
No related branches found
No related tags found
1 merge request!36Start branch for dev/0.8.2
Pipeline #435481 passed
......@@ -17,9 +17,18 @@ ScriptConfig
| Pypi | https://pypi.org/project/scriptconfig |
+------------------+--------------------------------------------------+
The goal of ``scriptconfig`` is to make it easy to be able to define a default
configuration by **simply defining a dictionary**, and then allow that
configuration to be modified by either:
* Define concise CLI or function signatures.
* Instantiate configs with YAML, cli-args, or kwargs.
* Can generate equivalent argparse (can help to prototype and be replaced with pure-argparse).
With ``scriptconfig``, define a flat key/value CLI with defaults using a
dictionary or dataclass-like syntax. Values can simply be the default value, or
a special ``scriptconfig.Value`` class that allows for metadata storage (e.g.
help, positional, required, etc...). The configuration can instantiated by
either:
1. Updating it with another Python dictionary (e.g. ``kwargs``)
2. Reading a YAML/JSON configuration file, or
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment