⏩ merge: branch 'main' into feature/add-data-quality-and-write-report-file-after-validation.

Author: korawica

src/sqlplate/conf.py

@@ -59,4 +59,4 @@ def config() -> Config:
         etl_columns=etl_columns,
         scd1_soft_delete_columns=scd1_soft_delete_columns,
         scd2_columns=scd2_columns,
-    )
+    )

src/sqlplate/sqlity.py

@@ -0,0 +1,10 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from __future__ import annotations
+
+
+class SQLity:
+    """A SQLity object for render data quality report by Jinja template."""

src/sqlplate/sqlplate.py

@@ -43,8 +43,14 @@ def __init__(self, name: str, path: Path) -> None:
         self._option: dict[str, Any] = {}
 
     @staticmethod
-    def formats(path: Optional[Path] = None) -> list[str]:
-        """Return supported formats"""
+    def list_formats(path: Optional[Path] = None) -> list[str]:
+        """Return supported formats with list of format value.
+
+        Arges:
+            path (Path | None): A template path that want to search.
+
+        :rtype: list[str]
+        """
         if path is None:
             path: Path = Path('./templates')
         return [

tests/test_sqlplate.py

@@ -11,7 +11,7 @@ def test_sqlplate_raise(template_path):
 
 
 def test_sqlplate_formats(template_path):
-    formats: list[str] = SQLPlate.formats(path=template_path)
+    formats: list[str] = SQLPlate.list_formats(path=template_path)
     assert isinstance(formats, list)
     assert len(formats) > 0
     assert 'utils' not in formats