pjdev-sqlmodel 3.6.0a4__tar.gz → 3.7.0__tar.gz

{pjdev_sqlmodel-3.6.0a4 → pjdev_sqlmodel-3.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pjdev-sqlmodel
-Version: 3.6.0a4
+Version: 3.7.0
 Project-URL: Documentation, https://gitlab.purplejay.net/keystone/python
 Project-URL: Issues, https://gitlab.purplejay.net/keystone/python/issues
 Project-URL: Source, https://gitlab.purplejay.net/keystone/python

{pjdev_sqlmodel-3.6.0a4 → pjdev_sqlmodel-3.7.0}/src/pjdev_sqlmodel/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present Chris O'Neill <chris@purplejay.io>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "3.6.0a4"
+__version__ = "3.7.0"

pjdev_sqlmodel-3.7.0/src/pjdev_sqlmodel/__init__.py

@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: 2024-present Chris O'Neill <chris@purplejay.io>
+#
+# SPDX-License-Identifier: MIT
+
+from loguru import logger
+
+logger.disable("pjdev_sqlmodel")
+
+from .models import *
+from .settings_service import get_settings, init_settings
+from .sqlmodel_service import (
+    session_context,
+    configure_single_context,
+    initialize_engine,
+    get_engine,
+)
+from .utilities import (
+    load_csv_data,
+    load_excel_data,
+    load_raw_csv_data,
+    load_raw_excel_data,
+    load_workbook,
+    get_files_in_directory,
+)
+
+__all__ = [
+    "models",
+    "get_settings",
+    "initialize_engine",
+    "session_context",
+    "configure_single_context",
+    "init_settings",
+    "get_engine",
+    "load_workbook",
+    "load_raw_excel_data",
+    "load_excel_data",
+    "load_raw_csv_data",
+    "load_csv_data",
+    "get_files_in_directory",
+]

pjdev_sqlmodel-3.7.0/src/pjdev_sqlmodel/models/__init__.py

@@ -0,0 +1,24 @@
+from .db_models import ModelBase, TableModel
+from .settings_models import (
+    SqlModelSettings,
+    SqliteSettings,
+    PostgresSettings,
+    MSSqlSettings,
+    PostgresConnectionOptions,
+    SqliteConnectionOptions,
+    TOptions,
+    TSettings,
+)
+
+__all__ = [
+    "ModelBase",
+    "TableModel",
+    "SqlModelSettings",
+    "SqliteSettings",
+    "PostgresSettings",
+    "MSSqlSettings",
+    "PostgresConnectionOptions",
+    "SqliteConnectionOptions",
+    "TOptions",
+    "TSettings",
+]

pjdev_sqlmodel-3.7.0/src/pjdev_sqlmodel/models/settings_models.py

@@ -0,0 +1,58 @@
+from pydantic import BaseModel
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from abc import ABC, abstractmethod
+from typing import TypeVar, Any, Dict
+from sqlalchemy.pool import NullPool
+
+
+class SqlModelSettings(BaseSettings, ABC):
+    host: str
+    db_name: str
+
+    @abstractmethod
+    def get_connection_string(self) -> str:
+        pass
+
+    model_config = SettingsConfigDict(
+        case_sensitive=False, extra="ignore", env_prefix="PJDEV_"
+    )
+
+
+class ConnectionOptions(BaseModel, ABC):
+    echo: bool = False
+
+
+TSettings = TypeVar(name="TSettings", bound=SqlModelSettings)
+TOptions = TypeVar(name="TOptions", bound=ConnectionOptions)
+
+
+class PostgresConnectionOptions(ConnectionOptions):
+    pool_size: int = 5
+    max_overflow: int = 10
+
+
+class SqliteConnectionOptions(ConnectionOptions):
+    connect_args: Dict[str, Any] = {"check_same_thread": False}
+    poolclass: Any = NullPool
+
+
+class MSSqlConnectionOptions(ConnectionOptions):
+    pass
+
+
+class MSSqlSettings(SqlModelSettings):
+    use_trusted_connection: bool = False
+    driver: int
+
+    def get_connection_string(self) -> str:
+        return f'mssql+pyodbc://{self.host}/{self.db_name}?driver=ODBC+Driver+{self.driver}+for+SQL+Server&Trusted_Connection={"yes" if self.use_trusted_connection else "no"}'
+
+
+class SqliteSettings(SqlModelSettings):
+    def get_connection_string(self) -> str:
+        return f"sqlite:///{self.host}.{self.db_name}"
+
+
+class PostgresSettings(SqlModelSettings):
+    def get_connection_string(self) -> str:
+        return f"postgresql+psycopg:///{self.host}.{self.db_name}"

pjdev_sqlmodel-3.7.0/src/pjdev_sqlmodel/settings_service.py

@@ -0,0 +1,23 @@
+from typing import (
+    Optional,
+)
+
+from pjdev_sqlmodel.models.settings_models import TSettings
+
+
+class Context:
+    settings: Optional[TSettings] = None
+
+
+__ctx = Context()
+
+
+def init_settings(settings: TSettings) -> None:
+    __ctx.settings = settings
+
+
+def get_settings() -> TSettings:
+    if __ctx.settings is None:
+        msg = "Settings are not initialized -- call init_settings()"
+        raise Exception(msg)
+    return __ctx.settings

pjdev_sqlmodel-3.6.0a4/src/pjdev_sqlmodel/service.py → pjdev_sqlmodel-3.7.0/src/pjdev_sqlmodel/sqlmodel_service.py

@@ -5,11 +5,10 @@ from typing import (
     List,
 )
 
-from sqlalchemy import Engine, NullPool
+from sqlalchemy import Engine
 from sqlmodel import create_engine, Session as SQLModelSession
 
-from pjdev_sqlmodel.db_models import ModelBase
-from pjdev_sqlmodel.settings import SqlModelSettings
+from .models import ModelBase, TOptions, TSettings
 
 
 class DBContext:
@@ -21,13 +20,13 @@ __ctx = DBContext()
 
 
 def initialize_engine(
-    settings: SqlModelSettings,
+    settings: TSettings,
+    opts: TOptions,
     tables: Optional[List[Type[ModelBase]]] = None,
-    echo: bool = False,
 ) -> Engine:
-    database_url = f"sqlite:///{settings.data_path}/{settings.sqlite_filename}"
+    database_url = settings.get_connection_string()
 
-    engine = create_engine(database_url, echo=echo, poolclass=NullPool)
+    engine = create_engine(database_url, **opts.model_dump())
 
     if tables is not None:
         for t in tables:
@@ -36,8 +35,10 @@ def initialize_engine(
     return engine
 
 
-def configure_single_context(settings: SqlModelSettings, tables: List[Type[ModelBase]]):
-    __ctx.engine = initialize_engine(settings, tables)
+def configure_single_context(
+    settings: TSettings, opts: TOptions, tables: List[Type[ModelBase]]
+):
+    __ctx.engine = initialize_engine(settings, opts=opts, tables=tables)
 
 
 def get_engine() -> Engine:

{pjdev_sqlmodel-3.6.0a4 → pjdev_sqlmodel-3.7.0}/src/pjdev_sqlmodel/utilities.py

@@ -8,9 +8,9 @@ import pandas as pd
 from openpyxl.reader.excel import load_workbook
 from loguru import logger
 from sqlalchemy import Engine
-from pjdev_sqlmodel import service
-from pjdev_sqlmodel.db_models import ModelBase
-from pjdev_sqlmodel.service import session_context
+
+from pjdev_sqlmodel import session_context, sqlmodel_service
+from pjdev_sqlmodel.models import ModelBase
 
 T = TypeVar("T", bound=ModelBase)
 
@@ -135,7 +135,7 @@ def load_raw_csv_data(
     if df is None:
         return
 
-    engine = service.get_engine() if engine is None else engine
+    engine = sqlmodel_service.get_engine() if engine is None else engine
     df.to_sql(
         table_name,
         con=engine,
@@ -157,7 +157,7 @@ def load_raw_excel_data(
     if df is None:
         return
 
-    engine = service.get_engine() if engine is None else engine
+    engine = sqlmodel_service.get_engine() if engine is None else engine
     df.to_sql(
         table_name,
         con=engine,

pjdev_sqlmodel-3.6.0a4/src/pjdev_sqlmodel/__init__.py

@@ -1,7 +0,0 @@
-# SPDX-FileCopyrightText: 2024-present Chris O'Neill <chris@purplejay.io>
-#
-# SPDX-License-Identifier: MIT
-
-from loguru import logger
-
-logger.disable("pjdev_sqlmodel")

pjdev_sqlmodel-3.6.0a4/src/pjdev_sqlmodel/settings.py

@@ -1,35 +0,0 @@
-from pathlib import Path
-from typing import (
-    Optional,
-)
-
-from pydantic_settings import BaseSettings, SettingsConfigDict
-
-
-class SqlModelSettings(BaseSettings):
-    data_path: Path
-    sqlite_filename: str = "data.db"
-
-    model_config = SettingsConfigDict(
-        case_sensitive=False, extra="ignore", env_prefix="PJDEV_"
-    )
-
-
-class Context:
-    settings: Optional[SqlModelSettings] = None
-
-
-__ctx = Context()
-
-
-def init_settings(root: Path, data_directory_name: str = ".data") -> None:
-    __ctx.settings = SqlModelSettings(
-        _env_file=root / ".env", data_path=root / data_directory_name
-    )
-
-
-def get_settings() -> SqlModelSettings:
-    if __ctx.settings is None:
-        msg = "Settings are not initialized -- call init_settings()"
-        raise Exception(msg)
-    return __ctx.settings