minor fixes to cli: exports, args

Author: tutankalex

nbs/01_cli.ipynb

@@ -28,7 +28,12 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "from schematized_config.core import ConfigValidator, load_json, extract_declared_items\n",
+    "from schematized_config.core import (\n",
+    "    ConfigValidator,\n",
+    "    ConfigValidatorException,\n",
+    "    load_json,\n",
+    "    extract_declared_items,\n",
+    ")\n",
     "\n",
     "import os\n",
     "import sys\n",
@@ -45,6 +50,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| export\n",
     "def validate_env(json_schema: Union[str, dict], dotenv_path: str=None):\n",
     "    validator = ConfigValidator(json_schema)\n",
     "    try:\n",
@@ -64,6 +70,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| export\n",
     "def generate_sample_dotenv(json_schema: Union[str, dict], seed_config: dict=None):\n",
     "    schema_dict = load_json(json_schema)\n",
     "    merged_config = dict(os.environ)\n",
@@ -130,19 +137,16 @@
     "\n",
     "@call_parse\n",
     "def main(\n",
-    "    generate: str = None,              # path to a json schema that validates a dotenv\n",
-    "    schema: str = None,                 # path to json schema used for validation\n",
-    "    validate: Union[bool, str] = None,  # validate a dotenv; if a path not given, assume .env; requires <schema>\n",
+    "    generate: str = None,  # path to a json schema that validates a dotenv\n",
+    "    schema: str = None,    # path to json schema used for validation\n",
+    "    validate: str = 'env',  # validate a dotenv; requires <schema>\n",
     "):\n",
     "    \"friendly tools to work with schemas and dotenv\"\n",
     "    \n",
     "    if generate:\n",
     "        sys.stdout.write(generate_sample_dotenv(generate))\n",
     "    elif schema and validate:\n",
-    "        if validate is True:\n",
-    "            dotenv_path = '.env'\n",
-    "        else:\n",
-    "            dotenv_path = None\n",
+    "        dotenv_path = validate\n",
     "        validate_env(schema, dotenv_path)"
    ]
   },

schematized_config/_modidx.py

@@ -7,7 +7,10 @@
                            '\n'
                            'requirements = jsonschema>=4.17.3 python-dotenv>=1.0.0/python-schematized-config',
                 'lib_path': 'schematized_config'},
-  'syms': { 'schematized_config.cli': {'schematized_config.cli.main': ('cli.html#main', 'schematized_config/cli.py')},
+  'syms': { 'schematized_config.cli': { 'schematized_config.cli.generate_sample_dotenv': ( 'cli.html#generate_sample_dotenv',
+                                                                                           'schematized_config/cli.py'),
+                                        'schematized_config.cli.main': ('cli.html#main', 'schematized_config/cli.py'),
+                                        'schematized_config.cli.validate_env': ('cli.html#validate_env', 'schematized_config/cli.py')},
             'schematized_config.core': { 'schematized_config.core.ConfigValidator': ( 'core.html#configvalidator',
                                                                                       'schematized_config/core.py'),
                                          'schematized_config.core.ConfigValidator.__init__': ( 'core.html#configvalidator.__init__',

schematized_config/cli.py

@@ -1,10 +1,15 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/01_cli.ipynb.
 
 # %% auto 0
-__all__ = ['main']
+__all__ = ['validate_env', 'generate_sample_dotenv', 'main']
 
 # %% ../nbs/01_cli.ipynb 2
-from .core import ConfigValidator, load_json, extract_declared_items
+from schematized_config.core import (
+    ConfigValidator,
+    ConfigValidatorException,
+    load_json,
+    extract_declared_items,
+)
 
 import os
 import sys
@@ -13,20 +18,48 @@
 from typing import Union
 from fastcore.script import *
 
+# %% ../nbs/01_cli.ipynb 3
+def validate_env(json_schema: Union[str, dict], dotenv_path: str=None):
+    validator = ConfigValidator(json_schema)
+    try:
+        validator.load_config(dotenv.dotenv_values(dotenv_path))
+        return True
+    except ConfigValidatorException as ex:
+        sys.stderr.write(f'{str(ex)}\n')
+        for error in ex.errors:
+            sys.stderr.write(f'{error.json_path}:\t{error.message}\n')
+        return False
+
+# %% ../nbs/01_cli.ipynb 4
+def generate_sample_dotenv(json_schema: Union[str, dict], seed_config: dict=None):
+    schema_dict = load_json(json_schema)
+    merged_config = dict(os.environ)
+    default_dotenv = dotenv.dotenv_values()
+    merged_config.update(default_dotenv)
+    merged_config.update(seed_config or {})
+    extracted_config = extract_declared_items(schema_dict, merged_config)
+    out = [
+        f'{key}={value}'
+        for key, value in extracted_config.items()
+    ]
+    # for all keys that are in the schema, but NOT in the current config,
+    # add them as comments
+    for (key, value_schema) in schema_dict['properties'].items():
+        if key not in extracted_config:
+            out.append(f'# {key}=<{value_schema.get("type")}>')
+    return '\n'.join(out)
+
 # %% ../nbs/01_cli.ipynb 6
 @call_parse
 def main(
-    generate: str = None,              # path to a json schema that validates a dotenv
-    schema: str = None,                 # path to json schema used for validation
-    validate: Union[bool, str] = None,  # validate a dotenv; if a path not given, assume .env; requires <schema>
+    generate: str = None,  # path to a json schema that validates a dotenv
+    schema: str = None,    # path to json schema used for validation
+    validate: str = 'env',  # validate a dotenv; requires <schema>
 ):
     "friendly tools to work with schemas and dotenv"
 
     if generate:
         sys.stdout.write(generate_sample_dotenv(generate))
     elif schema and validate:
-        if validate is True:
-            dotenv_path = '.env'
-        else:
-            dotenv_path = None
+        dotenv_path = validate
         validate_env(schema, dotenv_path)