Update CLI with output options arguments (#5)

Author: svdimchenko

README.md

@@ -34,27 +34,30 @@ and generate a JSON with column types that can be used with `terraform` to creat
 
 Take the following pydantic class
 
-```python
+```python title="example.py"
 from pydantic import BaseModel
 from typing import List
 
+
 class Bar(BaseModel):
     name: str
     age: int
 
+
 class Foo(BaseModel):
     nums: List[int]
     bars: List[Bar]
     other: str
+
 ```
 
 Running `pydantic-glue`
 
 ```bash
-pydantic-glue example.py Foo
+pydantic-glue -f example.py -c Foo
 ```
 
-you get this JSON
+you get this JSON in the terminal:
 
 ```json
 {
@@ -91,6 +94,12 @@ resource "aws_glue_catalog_table" "table" {
 }
 ```
 
+Alternatively you can run CLI with `-o` flag to set output file location:
+
+```bash
+pydantic-glue -f example.py -c Foo -o example.json -l
+```
+
 ## How it works?
 
 * `pydantic` gets converted to JSON Schema

pydantic_glue/cli.py

@@ -1,28 +1,47 @@
 import json
+import logging
 import os
 import sys
-from datetime import datetime
+from argparse import ArgumentParser
+from datetime import datetime, timezone
+from pathlib import Path
 
 from pydantic_glue import convert
 
+logging.basicConfig(format="{asctime} - {levelname} - {message}", level=logging.INFO, style="{", stream=sys.stdout)
+log = logging.getLogger(__name__)
+
 
 def cli() -> None:
-    if len(sys.argv) != 3:
-        print(f"Usage: {sys.argv[0]} <module file> <class name>", file=sys.stderr)
-        sys.exit(1)
+    parser = ArgumentParser()
+    parser.add_argument("-f", dest="source_file", required=True, type=str, help="Path to the python file")
+    parser.add_argument("-c", dest="class_name", required=True, type=str, help="Python class name")
+    parser.add_argument("-o", dest="output_file", required=False, type=str, help="Path to the output file")
+    parser.add_argument(
+        "-l", dest="log_result", action="store_true", default=False, help="Flag if need to print result in log"
+    )
+    args = parser.parse_args(sys.argv[1:])
 
-    module_file = sys.argv[1].replace(".py", "")
-    class_name = sys.argv[2]
+    module_file = args.source_file.removesuffix(".py")
 
     sys.path.append(os.path.dirname(module_file))
 
     imported = __import__(os.path.basename(module_file))
-    imported = getattr(imported, class_name)
+    imported = getattr(imported, args.class_name)
     input_schema = json.dumps(imported.model_json_schema())
     converted = convert(input_schema)
-    output = {
-        "//": f"Generated by pydantic-glue at {datetime.now()}. DO NOT EDIT",
-        "columns": {k: v for (k, v) in converted},
-    }
+    output = json.dumps(
+        {
+            "//": f"Generated by pydantic-glue at {datetime.now(tz=timezone.utc)}. DO NOT EDIT",
+            "columns": {k: v for (k, v) in converted},
+        },
+        indent=2,
+    )
+
+    if args.log_result or not args.output_file:
+        log.info(f"Generated file content:\n{output}")
 
-    print(json.dumps(output, indent=2))
+    if args.output_file:
+        ouf = Path(args.output_file)
+        ouf.parent.mkdir(parents=True, exist_ok=True)
+        ouf.write_text(output)

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "pydantic-glue"
 keywords = ["pydantic", "glue", "athena", "types", "convert"]
-version = "0.3.0"
+version = "0.4.0"
 description = "Convert pydantic model to aws glue schema for terraform"
 authors = ["Serhii Dimchenko <[email protected]>"]
 readme = "README.md"