Update package

Author: BenConstable9

pyproject.toml

@@ -13,6 +13,7 @@ dev = [
     "pre-commit>=4.0.1",
     "pygments>=2.18.0",
     "ruff>=0.8.1",
+    "python-dotenv>=1.0.1",
 ]
 
 [tool.uv.workspace]

text_2_sql/semantic_kernel/pyproject.toml

@@ -16,8 +16,8 @@ dev = [
     "jupyter>=1.1.1",
     "pre-commit>=4.0.1",
     "pygments>=2.18.0",
-    "python-dotenv>=1.0.1",
     "ruff>=0.8.1",
+    "python-dotenv>=1.0.1",
 ]
 
 [tool.uv.sources]

text_2_sql/text_2_sql_core/pyproject.toml

@@ -23,19 +23,25 @@ dependencies = [
     "typer>=0.14.0",
 ]
 
+[dependency-groups]
+dev = [
+    "black>=24.10.0",
+    "ipykernel>=6.29.5",
+    "jupyter>=1.1.1",
+    "pre-commit>=4.0.1",
+    "pygments>=2.18.0",
+    "ruff>=0.8.1",
+    "python-dotenv>=1.0.1",
+]
+
 [project.optional-dependencies]
 snowflake = [
     "snowflake-connector-python>=3.12.3",
 ]
 databricks = [
-    "databricks>=0.2",
+    "databricks-sql-connector>=3.0.1",
 ]
 
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
-
-[dependency-groups]
-dev = [
-    "python-dotenv>=1.0.1",
-]

text_2_sql/text_2_sql_core/src/text_2_sql_core/data_dictionary/cli.py

@@ -1,29 +1,14 @@
 import asyncio
-from importlib import metadata
 from pathlib import Path
 from typing import Annotated
 from text_2_sql_core.utils.database import DatabaseEngine
-
+import logging
 import typer
 from rich import print as rich_print
 
-cli = typer.Typer(pretty_exceptions_show_locals=False, no_args_is_help=True)
-
-__version__ = metadata.version(__package__)
-
+logging.basicConfig(level=logging.INFO)
 
-def version_callback(value: bool) -> None:
-    """Print the version of the CLI."""
-    if value:
-        print(__version__)
-        raise typer.Exit()
-
-
-@cli.callback()
-def callback(
-    _: bool = typer.Option(None, "--version", "-v", callback=version_callback)
-) -> None:
-    """Text2SQL Data Dictionary Creator CLI."""
+cli = typer.Typer(pretty_exceptions_show_locals=False, no_args_is_help=True)
 
 
 @cli.command()
@@ -71,20 +56,27 @@ def create(
                 DatabricksDataDictionaryCreator,
             )
 
-            data_dictionary_creator = DatabricksDataDictionaryCreator()
+            data_dictionary_creator = DatabricksDataDictionaryCreator(
+                single_file=single_file, output_directory=output_directory
+            )
         elif engine == DatabaseEngine.SNOWFLAKE:
             from text_2_sql_core.data_dictionary.snowflake_data_dictionary_creator import (
                 SnowflakeDataDictionaryCreator,
             )
 
-            data_dictionary_creator = SnowflakeDataDictionaryCreator()
+            data_dictionary_creator = SnowflakeDataDictionaryCreator(
+                single_file=single_file, output_directory=output_directory
+            )
         elif engine == DatabaseEngine.TSQL:
             from text_2_sql_core.data_dictionary.tsql_data_dictionary_creator import (
                 TSQLDataDictionaryCreator,
             )
 
-            data_dictionary_creator = TSQLDataDictionaryCreator()
-    except ImportError:
+            data_dictionary_creator = TSQLDataDictionaryCreator(
+                single_file=single_file, output_directory=output_directory
+            )
+    except ImportError as e:
+        print(e)
         detailed_error = f"""Failed to import {
             engine.value} Data Dictionary Creator. Check you have installed the optional dependencies for this database engine."""
         rich_print("Text2SQL Data Dictionary Creator Failed ❌")
@@ -102,3 +94,7 @@ def create(
         raise typer.Exit(code=1)
     else:
         rich_print("Text2SQL Data Dictionary Creator Completed Successfully ✅")
+
+
+if __name__ == "__main__":
+    cli()

text_2_sql/text_2_sql_core/src/text_2_sql_core/data_dictionary/data_dictionary_creator.py

@@ -166,6 +166,7 @@ def __init__(
         excluded_schemas: list[str] = None,
         single_file: bool = False,
         generate_definitions: bool = True,
+        output_directory: str = None,
     ):
         """A method to initialize the DataDictionaryCreator class.
 
@@ -177,6 +178,9 @@ def __init__(
             generate_definitions (bool, optional): A flag to indicate if definitions should be generated. Defaults to True.
         """
 
+        if excluded_entities is None:
+            excluded_entities = []
+
         self.entities = entities
         self.excluded_entities = excluded_entities
         self.excluded_schemas = excluded_schemas
@@ -192,6 +196,9 @@ def __init__(
 
         self.database_engine = None
 
+        if output_directory is None:
+            self.output_directory = "."
+
         load_dotenv(find_dotenv())
 
     @property
@@ -677,7 +684,9 @@ async def create_data_dictionary(self):
         # Save data dictionary to file
         if self.single_file:
             logging.info("Saving data dictionary to entities.json")
-            with open("entities.json", "w", encoding="utf-8") as f:
+            with open(
+                f"{self.output_directory}/entities.json", "w", encoding="utf-8"
+            ) as f:
                 data_dictionary_dump = [
                     entity.model_dump(
                         by_alias=True, exclude=self.excluded_fields_for_database_engine
@@ -693,7 +702,11 @@ async def create_data_dictionary(self):
         else:
             for entity in data_dictionary:
                 logging.info(f"Saving data dictionary for {entity.entity}")
-                with open(f"{entity.entity}.json", "w", encoding="utf-8") as f:
+                with open(
+                    f"{self.output_directory}/{entity.entity}.json",
+                    "w",
+                    encoding="utf-8",
+                ) as f:
                     json.dump(
                         entity.model_dump(
                             by_alias=True,

text_2_sql/text_2_sql_core/src/text_2_sql_core/data_dictionary/databricks_data_dictionary_creator.py

@@ -9,24 +9,11 @@
 
 
 class DatabricksDataDictionaryCreator(DataDictionaryCreator):
-    def __init__(
-        self,
-        entities: list[str] = None,
-        excluded_entities: list[str] = None,
-        single_file: bool = False,
-    ):
-        """A method to initialize the DataDictionaryCreator class.
+    def __init__(self, **kwargs):
+        """A method to initialize the DataDictionaryCreator class."""
 
-        Args:
-            entities (list[str], optional): A list of entities to extract. Defaults to None. If None, all entities are extracted.
-            excluded_entities (list[str], optional): A list of entities to exclude. Defaults to None.
-            single_file (bool, optional): A flag to indicate if the data dictionary should be saved to a single file. Defaults to False.
-        """
-        if excluded_entities is None:
-            excluded_entities = []
-
-        excluded_schemas = []
-        super().__init__(entities, excluded_entities, excluded_schemas, single_file)
+        excluded_schemas = ["INFORMATION_SCHEMA"]
+        super().__init__(excluded_schemas=excluded_schemas, **kwargs)
 
         self.catalog = os.environ["Text2Sql__Databricks__Catalog"]
         self.database_engine = DatabaseEngine.DATABRICKS

text_2_sql/text_2_sql_core/src/text_2_sql_core/data_dictionary/snowflake_data_dictionary_creator.py

@@ -10,24 +10,11 @@
 
 
 class SnowflakeDataDictionaryCreator(DataDictionaryCreator):
-    def __init__(
-        self,
-        entities: list[str] = None,
-        excluded_entities: list[str] = None,
-        single_file: bool = False,
-    ):
-        """A method to initialize the DataDictionaryCreator class.
-
-        Args:
-            entities (list[str], optional): A list of entities to extract. Defaults to None. If None, all entities are extracted.
-            excluded_entities (list[str], optional): A list of entities to exclude. Defaults to None.
-            single_file (bool, optional): A flag to indicate if the data dictionary should be saved to a single file. Defaults to False.
-        """
-        if excluded_entities is None:
-            excluded_entities = []
+    def __init__(self, **kwargs):
+        """A method to initialize the DataDictionaryCreator class."""
 
         excluded_schemas = ["INFORMATION_SCHEMA"]
-        super().__init__(entities, excluded_entities, excluded_schemas, single_file)
+        super().__init__(excluded_schemas=excluded_schemas, **kwargs)
 
         self.database = os.environ["Text2Sql__DatabaseName"]
         self.warehouse = os.environ["Text2Sql__Snowflake__Warehouse"]

text_2_sql/text_2_sql_core/src/text_2_sql_core/data_dictionary/tsql_data_dictionary_creator.py

@@ -7,24 +7,16 @@
 
 
 class TSQLDataDictionaryCreator(DataDictionaryCreator):
-    def __init__(
-        self,
-        entities: list[str] = None,
-        excluded_entities: list[str] = None,
-        single_file: bool = False,
-    ):
+    def __init__(self, **kwargs):
         """A method to initialize the DataDictionaryCreator class.
 
         Args:
             entities (list[str], optional): A list of entities to extract. Defaults to None. If None, all entities are extracted.
             excluded_entities (list[str], optional): A list of entities to exclude. Defaults to None.
             single_file (bool, optional): A flag to indicate if the data dictionary should be saved to a single file. Defaults to False.
         """
-        if excluded_entities is None:
-            excluded_entities = []
-
         excluded_schemas = ["dbo", "sys"]
-        super().__init__(entities, excluded_entities, excluded_schemas, single_file)
+        super().__init__(excluded_schemas=excluded_schemas, **kwargs)
         self.database = os.environ["Text2Sql__DatabaseName"]
 
         self.database_engine = DatabaseEngine.TSQL