added cli with command dump

Author: xnuinside

CHANGELOG.txt

@@ -1,3 +1,7 @@
+**v0.3.0**
+1. Added cli - `pmp` command with args -d, --dump  
+2. Add support for pure Python classes
+
 **v0.2.0**
 1. Added support for Dataclasses
 2. Added parse_from_file method

README.md

@@ -4,7 +4,17 @@
 
 
 It's as second Parser that done by me, first is a https://github.com/xnuinside/simple-ddl-parser for SQL DDL with different dialects.
-Py-Models-Parser supports now ORM Sqlalchemy, Gino, Tortoise; Pydantic, Python Enum models, Dataclasses & in nearest feature I plan to add pure pyton classes. And next will be added other ORMs models.
+
+Py-Models-Parser can parse & extract information from models:
+
+- Sqlalchemy ORM,
+- Gino ORM,
+- Tortoise ORM,
+- Pydantic,
+- Python Enum,
+- Python Dataclasses
+
+Number of supported models will be increased, check 'TODO' section.
 
 Py-Models-Parser written with PEG parser and it's python implementation - parsimonious. It's pretty new and I did not cover all possible test cases, so if you will have an issue  - please just open an issue in this case with example, I will fix it as soon as possible.
 
@@ -51,7 +61,7 @@ NOTE: it's is a text parser, so it don't import or load your code, parser work w
 
 Library detect automaticaly that type of models you tries to parse. You can check a lot of examples in test/ folder on the GitHub
 
-You can parse models from python string:
+1. You can parse models from python string:
 
 ```python
 
@@ -75,7 +85,7 @@ result = parse(models_str)
 
 ```
 
-or just provide the path to file:
+2. Parse models from file:
 
 ```python
 
@@ -87,7 +97,31 @@ or just provide the path to file:
     result = parse_from_file(file_path)
 ```
 
-It will produce the result:
+3. Parse models from file with command line
+
+```bash
+
+    pmp path_to_models.py 
+
+    # for example: pmp tests/data/dataclass_defaults.py
+
+```
+
+Output from cli can be dumped in 'output_models.json' file - use flag '-d' '--dump' if you want to change target file name, provide it after argument like '-d target_file.json'
+
+```bash
+
+    # example how to dump output from cli
+
+    pmp path_to_models.py -d target_file.json
+
+```
+
+### Output example
+
+You can find a lot of output examples in tests - https://github.com/xnuinside/py-models-parser/tree/main/tests
+
+For model from point 1 (above) library will produce the result:
 
 ```python
 
@@ -132,20 +166,17 @@ It will produce the result:
     ]
 ```
 
-
 ## TODO: in next Release
 
-1. Parse from file method
-2. Add cli
-3. Add more tests for supported models (and fix existed not covered cases): Pydantic, Enums, Dataclasses, SQLAlchemy Models, GinoORM models, TortoiseORM models
-4. Add support for pure Python classes
-5. Add support for pure SQLAlchemy Core Tables
+1. Add more tests for supported models (and fix existed not covered cases): Pydantic, Enums, Dataclasses, SQLAlchemy Models, GinoORM models, TortoiseORM models
+2. Add support for pure SQLAlchemy Core Tables
+3. Add support for Pony ORM models
 
 ## Changelog
 **v0.2.0**
 1. Added support for Dataclasses
 2. Added parse_from_file method
-3. Added correct work with types with comma inside, like: Union[dict, list] or Union[dict, list, tuple, anything] 
+3. Added correct work with types with comma inside, like: Union[dict, list] or Union[dict, list, tuple, anything]
 
 **v0.1.1**
 1. Added base parser logic & tests for Pydantic, Enums, SQLAlchemy Models, GinoORM models, TortoiseORM models 

py_models_parser/__init__.py

@@ -1,3 +1,3 @@
-from py_models_parser.core import parse, parse_from_file
+from py_models_parser.core import dump_result, parse, parse_from_file
 
-__all__ = ["parse", "parse_from_file"]
+__all__ = ["parse", "parse_from_file", "dump_result"]

py_models_parser/cli.py

@@ -0,0 +1,68 @@
+import argparse
+import os
+import pprint
+import sys
+
+from py_models_parser import dump_result, parse_from_file
+
+
+def version(**kwargs):
+    return "0.2.0"
+
+
+def cli():
+    pmp_cli = argparse.ArgumentParser(description="Python Models Parser")
+
+    pmp_cli.add_argument(
+        "file_path", type=str, help="The path to .py file with models to parse"
+    )
+
+    pmp_cli.add_argument(
+        "-d",
+        "--dump",
+        nargs="?",
+        type=str,
+        const="output_models.json",
+        help="Target path to save parse results in .json files",
+    )
+
+    return pmp_cli
+
+
+def run_for_file(args):
+    print(f"Start parsing file {args.file_path} \n")
+    result = parse_from_file(args.file_path)
+    if args.dump:
+        dump_result(result, args.dump)
+    print(f"File with result was saved to >> {args.dump} file")
+    if not args.dump:
+        pprint.pprint(result)
+
+
+def correct_extension(file_name: str) -> bool:
+    ext = ["ddl", "sql", "hql", ""]
+    split_name = file_name.split(".")
+    if len(split_name) >= 2:
+        ext_file = split_name[1]
+        if ext_file in ext:
+            return True
+    return False
+
+
+def main():
+    sdb_cli = cli()
+    args = sdb_cli.parse_args()
+    if not os.path.exists(args.file_path):
+        print("The file path specified does not exist")
+        sys.exit()
+    if os.path.isfile(args.file_path):
+        run_for_file(args)
+    else:
+        files = [
+            os.path.join(args.ddl_file_path, file_name)
+            for file_name in os.listdir(args.ddl_file_path)
+            if correct_extension(file_name)
+        ]
+        for file_path in files:
+            args.ddl_file_path = file_path
+            run_for_file(args)

py_models_parser/core.py

@@ -1,3 +1,4 @@
+import json
 import os
 from typing import Dict, List
 
@@ -76,3 +77,8 @@ def parse_from_file(file_path: str) -> List[Dict]:
     with open(file_path, "r") as f:
         models = f.read()
         return parse(models)
+
+
+def dump_result(output: str, file_path: str) -> None:
+    with open(file_path, "w+") as f:
+        json.dump(output, f, indent=1)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "py-models-parser"
-version = "0.2.0"
+version = "0.3.0"
 description = "Parser for Different Python Models (Pydantic, Enums, ORMs: Tortoise, SqlAlchemy, GinoORM) to extract information about columns(attrs), model, table args,etc in one format."
 authors = ["Iuliia Volkova <xnuinside@gmail.com>"]
 license = "MIT"
@@ -26,6 +26,9 @@ pytest = "^5.2"
 twine = "^3.4.1"
 m2r = "^0.2.1"
 
+[tool.poetry.scripts]
+pmp = 'py_models_parser.cli:main'
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"