csvpath 0.0.598__tar.gz → 0.0.599__tar.gz

{csvpath-0.0.598 → csvpath-0.0.599}/PKG-INFO

@@ -1,7 +1,8 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: csvpath
-Version: 0.0.598
+Version: 0.0.599
 Summary: CsvPath Framework is a data preboarding automation library for receiving, validating, and tracking CSV, Excel, JSONL and other tabular data files before they can corrupt downstream data consumers.
+License-File: LICENSE
 Author: David Kershaw
 Author-email: info@csvpath.org
 Requires-Python: >3.10,<4.0
@@ -13,6 +14,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: File Formats
 Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -21,40 +23,41 @@ Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Text Processing
 Classifier: Topic :: Utilities
 Provides-Extra: pandas
-Requires-Dist: azure-storage-blob (>=12.24.1,<13.0.0)
-Requires-Dist: boto3 (>=1.35.91,<2.0.0)
-Requires-Dist: ckanapi (>=4.8,<5.0)
-Requires-Dist: email-validator (>=2.2.0,<3.0.0)
-Requires-Dist: google-cloud-storage (>=3.1.0,<4.0.0)
-Requires-Dist: inflect (>=7.4.0,<8.0.0)
-Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
-Requires-Dist: jsonlines (>=4.0.0,<5.0.0)
-Requires-Dist: jsonpath-ng (>=1.7.0,<2.0.0)
-Requires-Dist: jsonpickle (>=4.1.1,<5.0.0)
-Requires-Dist: lark (>=1.2.2,<2.0.0)
-Requires-Dist: lxml (>=6.0.2,<7.0.0)
-Requires-Dist: marquez-python (>=0.50.0,<0.51.0)
-Requires-Dist: metaphone (>=0.6,<0.7)
-Requires-Dist: mysqlclient (>=2.2.7,<3.0.0)
-Requires-Dist: openlineage-python (>=1.25.0,<2.0.0)
-Requires-Dist: opentelemetry-distro[otlp] (>=0.50b0,<0.51)
-Requires-Dist: pandas (>=2.2.2,<3.0.0) ; extra == "pandas"
-Requires-Dist: paramiko (>=3.5.0,<4.0.0)
-Requires-Dist: pdoc (>=15.0.1,<16.0.0)
-Requires-Dist: prompt-toolkit (>=3.0.50,<4.0.0)
-Requires-Dist: psycopg2-binary (>=2.9.10,<3.0.0)
-Requires-Dist: pyarrow (>=23.0.1,<24.0.0)
-Requires-Dist: pydantic (>=2.12.5,<3.0.0)
-Requires-Dist: pyjson5 (>=2.0.0,<3.0.0)
-Requires-Dist: pylightxl (>=1.61,<2.0)
-Requires-Dist: pytest (>=8.3.3,<9.0.0)
-Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
-Requires-Dist: pytz (>=2024.2,<2025.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: smart-open[all] (>=7.1.0,<8.0.0)
-Requires-Dist: sqlalchemy (>=2.0.38,<3.0.0)
-Requires-Dist: tabulate (>=0.9.0,<0.10.0)
-Requires-Dist: validators (>=0.34.0,<0.35.0)
+Requires-Dist: azure-storage-blob (==12.28.0)
+Requires-Dist: boto3 (==1.42.65)
+Requires-Dist: ckanapi (==4.9)
+Requires-Dist: email-validator (==2.3.0)
+Requires-Dist: google-cloud-storage (==3.9.0)
+Requires-Dist: inflect (==7.5.0)
+Requires-Dist: jinja2 (==3.1.6)
+Requires-Dist: jsonlines (==4.0.0)
+Requires-Dist: jsonpath-ng (==1.8.0)
+Requires-Dist: jsonpickle (==4.1.1)
+Requires-Dist: lark (==1.3.1)
+Requires-Dist: lxml (==6.0.2)
+Requires-Dist: marquez-python (==0.50.0)
+Requires-Dist: metaphone (==0.6)
+Requires-Dist: mysqlclient (==2.2.8)
+Requires-Dist: openlineage-python (==1.45.0)
+Requires-Dist: opentelemetry-distro[otlp] (==0.50b0)
+Requires-Dist: pandas (==2.3.3) ; extra == "pandas"
+Requires-Dist: paramiko (==3.5.1)
+Requires-Dist: pdoc (==15.0.4)
+Requires-Dist: prompt-toolkit (==3.0.52)
+Requires-Dist: psutil (>=7.2.2,<8.0.0)
+Requires-Dist: psycopg2-binary (==2.9.11)
+Requires-Dist: pyarrow (==23.0.1)
+Requires-Dist: pydantic (==2.12.5)
+Requires-Dist: pyjson5 (==2.0.0)
+Requires-Dist: pylightxl (==1.61)
+Requires-Dist: pytest (==8.4.2)
+Requires-Dist: python-dateutil (==2.9.0.post0)
+Requires-Dist: pytz (==2024.2)
+Requires-Dist: requests (==2.32.5)
+Requires-Dist: smart-open[all] (==7.5.1)
+Requires-Dist: sqlalchemy (==2.0.48)
+Requires-Dist: tabulate (==0.9.0)
+Requires-Dist: validators (==0.34.0)
 Project-URL: Csvpath.org, https://www.csvpath.org
 Project-URL: Github, https://github.com/csvpath/csvpath.git
 Description-Content-Type: text/markdown

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/config.ini

@@ -81,8 +81,8 @@ slack.results = from csvpath.managers.integrations.slack.sender import SlackSend
 [gcs]
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-local-azure.ini

@@ -74,8 +74,8 @@ scripts.results = from csvpath.managers.integrations.scripts.scripts_results_lis
 [gcs]
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-local-filesystem-mysql.ini

@@ -77,8 +77,8 @@ scripts.results = from csvpath.managers.integrations.scripts.scripts_results_lis
 #
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-local-gcs.ini

@@ -31,7 +31,7 @@ path = cache
 use_cache = no
 
 [functions]
-imports =
+imports = 
 
 [results]
 archive = tmp/gcs/archive
@@ -44,7 +44,7 @@ allow_http_files = True
 allow_local_files = True
 
 [listeners]
-groups =
+groups = default
 sqlite.result = from csvpath.managers.integrations.sqlite.sqlite_result_listener import SqliteResultListener
 sqlite.results = from csvpath.managers.integrations.sqlite.sqlite_results_listener import SqliteResultsListener
 default.file = from csvpath.managers.files.files_listener import FilesListener
@@ -74,12 +74,11 @@ scripts.results = from csvpath.managers.integrations.scripts.scripts_results_lis
 [gcs]
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 
-
 [sqlite]
 db = archive/csvpath.db
 
@@ -91,7 +90,7 @@ port = SFTPPLUS_PORT
 admin_username = SFTPPLUS_ADMIN_USERNAME
 admin_password = SFTPPLUS_ADMIN_PASSWORD
 api_url = https://. . . :10020/json
-scripts_dir =
+scripts_dir = 
 execute_timeout = 300
 
 [ckan]
@@ -106,5 +105,5 @@ timeout = 5
 verify = False
 
 [slack]
-webhook_url =
+webhook_url = 
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-local-s3.ini

@@ -74,8 +74,8 @@ scripts.results = from csvpath.managers.integrations.scripts.scripts_results_lis
 [gcs]
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-local-sftp.ini

@@ -31,7 +31,7 @@ imports =
 archive = tmp/sftp/archive
 
 [inputs]
-files = sftp://192.168.1.152:2022/mac/inputs/named_files
+files = sftp://{SFTP_SERVER}:{SFTP_PORT}/mac/inputs/named_files
 csvpaths = tmp/sftp/inputs/named_paths
 on_unmatched_file_fingerprints = halt
 allow_http_files = True
@@ -78,8 +78,8 @@ shell = /bin/bash
 [gcs]
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-windows-azure.ini

@@ -72,8 +72,8 @@ scripts.results = from csvpath.managers.integrations.scripts.scripts_results_lis
 run_scripts=yes
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-windows-gcs.ini

@@ -111,8 +111,8 @@ slack.results = from csvpath.managers.integrations.slack.sender import SlackSend
 #
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-windows-local.ini

@@ -26,7 +26,7 @@ path = cache
 use_cache = no
 
 [functions]
-imports = 
+imports =
 
 [results]
 archive = tmp\local\archive
@@ -69,8 +69,8 @@ slack.results = from csvpath.managers.integrations.slack.sender import SlackSend
 [gcs]
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 
@@ -85,7 +85,7 @@ port = SFTPPLUS_PORT
 admin_username = SFTPPLUS_ADMIN_USERNAME
 admin_password = SFTPPLUS_ADMIN_PASSWORD
 api_url = https://. . . :10020/json
-scripts_dir = 
+scripts_dir =
 execute_timeout = 300
 
 [ckan]
@@ -100,7 +100,7 @@ timeout = 5
 verify = False
 
 [slack]
-webhook_url = 
+webhook_url =
 
 [scripts]
 run_scripts = yes

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-windows-s3.ini

@@ -74,8 +74,8 @@ scripts.results = from csvpath.managers.integrations.scripts.scripts_results_lis
 [gcs]
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

{csvpath-0.0.598 → csvpath-0.0.599}/assets/config/jenkins-windows-sftp.ini

@@ -40,7 +40,7 @@ imports =
 archive = tmp\sftp\archive
 
 [inputs]
-files = sftp://192.168.1.152:2022/windows/inputs\named_files
+files = sftp://{SFTP_SERVER}:{SFTP_PORT}/windows/inputs/named_files
 csvpaths = tmp\sftp\inputs\named_paths
 on_unmatched_file_fingerprints = halt
 allow_http_files=True
@@ -112,8 +112,8 @@ scripts.results = from csvpath.managers.integrations.scripts.scripts_results_lis
 #
 
 [sftp]
-server = 192.168.1.152
-port = 2022
+server = SFTP_SERVER
+port = SFTP_PORT
 username = python
 password = hangzhou
 

csvpath-0.0.599/assets/gocd/Mac.goenvironment.json

@@ -0,0 +1,11 @@
+{
+    "name": "Mac",
+    "pipelines": [
+      "azure-pipeline",
+      "google-pipeline",
+      "s3-pipeline",
+      "sftp-pipeline"
+    ],
+    "agents": []
+}
+

csvpath-0.0.599/assets/gocd/Windows.goenvironment.json

@@ -0,0 +1,12 @@
+{
+    "name": "Windows",
+    "pipelines": [
+      "windows-azure",
+      "windows-gcs",
+      "windows-s3",
+      "windows-sftp",
+      "windows-local"
+    ],
+    "agents": []
+}
+

{csvpath-0.0.598 → csvpath-0.0.599}/config/config.ini

@@ -35,7 +35,7 @@ path = cache
 use_cache = yes
 
 [functions]
-imports = 
+imports =
 
 [results]
 archive = tmp/local/archive
@@ -85,7 +85,7 @@ slack.results = from csvpath.managers.integrations.slack.sender import SlackSend
 [gcs]
 
 [sftp]
-server = 192.168.1.152
+server = SFTP_SERVER
 port = 2022
 username = python
 password = hangzhou
@@ -105,7 +105,7 @@ port = SFTPPLUS_PORT
 admin_username = SFTPPLUS_ADMIN_USERNAME
 admin_password = SFTPPLUS_ADMIN_PASSWORD
 api_url = https://. . . :10020/json
-scripts_dir = 
+scripts_dir =
 execute_timeout = 300
 
 [ckan]
@@ -120,7 +120,7 @@ timeout = 5
 verify = False
 
 [slack]
-webhook_url = 
+webhook_url =
 
 [scripts]
 run_scripts = yes

{csvpath-0.0.598 → csvpath-0.0.599}/csvpath/csvpath.py

@@ -54,6 +54,13 @@ class CsvPath(ErrorCollector, Printer):  # pylint: disable=R0902, R0904
         skip_blank_lines=True,
         print_default=True,
         # config=None,
+        #
+        # atm, we don't use this error manager reference. instead we make
+        # an error manager for this csvpath, and if we have a csvpaths we
+        # add its error_manager as an internal listener for error events
+        #
+        # we can refactor this reference away
+        #
         error_manager=None,
         project_context="no_project_context",
         project="no_project_name",

{csvpath-0.0.598 → csvpath-0.0.599}/csvpath/csvpaths.py

@@ -422,6 +422,9 @@ Cache: {cache}
             #
             # config=None,
             print_default=self.print_default,
+            #
+            # we don't use this error manager reference atm.
+            #
             error_manager=self.error_manager,
             project=self.project,
             project_context=self.project_context,
@@ -545,7 +548,6 @@ Cache: {cache}
         box = Box()
         ds = []
         for k, v in box.get_my_stuff().items():
-            self.logger.debug(f"csvpaths.wrapping up: {k}: {v}")
             if hasattr(v, "close"):
                 ds.append(k)
         for _ in ds:

{csvpath-0.0.598 → csvpath-0.0.599}/csvpath/managers/errors/error_comms.py

@@ -1,3 +1,6 @@
+
+import weakref
+
 from typing import Any, List
 from csvpath.util.config import OnError
 from csvpath.modes.error_mode import ErrorMode
@@ -22,32 +25,42 @@ class ErrorCommunications:
     """
 
     def __init__(self, csvpath=None, csvpaths=None) -> None:
-        self._csvpath = csvpath
-        self._csvpaths = csvpaths
         if not csvpath and not csvpaths:
             raise ValueError("Must have either a CsvPath or CsvPaths instance")
+        if csvpath and csvpaths:
+            raise ValueError("Cannot have both a csvpath and csvpaths handling the same errors")
+        self._csvpath = None if csvpath is None else weakref.ref(csvpath)
+        self._csvpaths = None if csvpaths is None else weakref.ref(csvpaths)
+
+    @property
+    def csvpath(self):
+        return None if self._csvpath is None else self._csvpath()
+
+    @property
+    def csvpaths(self):
+        return None if self._csvpaths is None else self._csvpaths()
 
     def do_i_quiet(self) -> bool:
         return self.in_policy(OnError.QUIET.value)
 
     def do_i_raise(self) -> bool:
-        if self._csvpath and self._csvpath.raise_validation_errors is not None:
-            return self._csvpath.raise_validation_errors
+        if self.csvpath and self.csvpath.raise_validation_errors is not None:
+            return self.csvpath.raise_validation_errors
         return self.in_policy(OnError.RAISE.value)
 
     def do_i_collect(self) -> bool:
-        if self._csvpath and self._csvpath.collect_validation_errors is not None:
-            return self._csvpath.collect_validation_errors
+        if self.csvpath and self.csvpath.collect_validation_errors is not None:
+            return self.csvpath.collect_validation_errors
         return self.in_policy(OnError.COLLECT.value)
 
     def do_i_print(self) -> bool:
-        if self._csvpath and self._csvpath.print_validation_errors is not None:
-            return self._csvpath.print_validation_errors
+        if self.csvpath and self.csvpath.print_validation_errors is not None:
+            return self.csvpath.print_validation_errors
         return self.in_policy(OnError.PRINT.value)
 
     def do_i_print_expanded(self) -> bool:
         ret = False
-        c = self._csvpath if self._csvpath is not None else self._csvpaths
+        c = self.csvpath if self.csvpath is not None else self.csvpaths
         if c is not None:
             ret = (
                 c.config.get(
@@ -55,7 +68,7 @@ class ErrorCommunications:
                 )
                 == ErrorMode.FULL
             )
-        if self._csvpath and self._csvpath.error_mode == ErrorMode.FULL:
+        if self.csvpath and self.csvpath.error_mode == ErrorMode.FULL:
             ret = True
         return ret
 
@@ -63,8 +76,8 @@ class ErrorCommunications:
         #
         # stop is having problems. copying raise, which works fine.
         #
-        if self._csvpath and self._csvpath.stop_on_validation_errors is not None:
-            return self._csvpath.stop_on_validation_errors
+        if self.csvpath and self.csvpath.stop_on_validation_errors is not None:
+            return self.csvpath.stop_on_validation_errors
         return self.in_policy(OnError.STOP.value)
         """
         mode = None
@@ -83,11 +96,11 @@ class ErrorCommunications:
         """
 
     def do_i_fail(self) -> bool:
-        if self._csvpath and self._csvpath.fail_on_validation_errors is not None:
-            return self._csvpath.fail_on_validation_errors
+        if self.csvpath and self.csvpath.fail_on_validation_errors is not None:
+            return self.csvpath.fail_on_validation_errors
         return self.in_policy(OnError.FAIL.value)
 
     def in_policy(self, v) -> bool:
-        if self._csvpath:
-            return v in self._csvpath.config.csvpath_errors_policy
-        return v in self._csvpaths.config.csvpaths_errors_policy
+        if self.csvpath:
+            return v in self.csvpath.config.csvpath_errors_policy
+        return v in self.csvpaths.config.csvpaths_errors_policy

{csvpath-0.0.598 → csvpath-0.0.599}/csvpath/managers/errors/error_manager.py

@@ -1,4 +1,6 @@
 import os
+import weakref
+
 from typing import Any
 from datetime import datetime, timezone
 from csvpath.util.config import OnError
@@ -16,7 +18,7 @@ class ErrorManager(Registrar, Listener):
     """creates errors uses the csvpaths's or csvpath's error policy to handle them."""
 
     def __init__(self, *, csvpaths=None, csvpath=None, error_collector=None):
-        self.csvpath = csvpath
+        self._csvpath = None if csvpath is None else weakref.ref(csvpath)
         self._csvpaths = None
         if csvpaths is not None:
             self.csvpaths = csvpaths
@@ -24,7 +26,7 @@ class ErrorManager(Registrar, Listener):
             self.csvpaths = csvpath.csvpaths
         if self.csvpath is None and self.csvpaths is None:
             raise ValueError("CsvPaths and/or CsvPath must be provided")
-        self._collector = csvpath if csvpath else csvpaths
+        #self._collector = csvpath if csvpath else csvpaths
         #
         #
         #
@@ -45,6 +47,14 @@ class ErrorManager(Registrar, Listener):
         self.error_metrics = None
         self.full_format = None
 
+    @property
+    def collector(self):
+        return self.csvpath if self.csvpath else self.csvpaths
+
+    @property
+    def csvpath(self):
+        return None if self._csvpath is None else self._csvpath()
+
     @property
     def csvpaths(self):
         return self._csvpaths
@@ -190,7 +200,7 @@ class ErrorManager(Registrar, Listener):
             #
             #
             #
-            self._collector.logger.error(e)
+            self.collector.logger.error(e)
         if self.full_format is None:
             self.full_format = (
                 "{time}:{file}:{line}:{paths}:{instance}:{chain}: {message}"
@@ -249,26 +259,26 @@ class ErrorManager(Registrar, Listener):
         # but not in the csvpath modes. both of these things could change.
         #
         if self.ecoms.do_i_quiet():
-            self._collector.logger.error(
+            self.collector.logger.error(
                 f"Qt {mdata.uuid_string}: message: {mdata.message}"
             )
-            self._collector.logger.error(
+            self.collector.logger.error(
                 f"Qt {mdata.uuid_string}: named_paths_name: {mdata.named_paths_name}"
             )
-            self._collector.logger.error(
+            self.collector.logger.error(
                 f"Qt {mdata.uuid_string}: path identity: {mdata.identity}"
             )
-            self._collector.logger.error(
+            self.collector.logger.error(
                 f"Qt {mdata.uuid_string}: file: {mdata.filename}"
             )
-            self._collector.logger.error(
+            self.collector.logger.error(
                 f"Qt {mdata.uuid_string}: line: {mdata.line_count}"
             )
-            self._collector.logger.error(
+            self.collector.logger.error(
                 f"Qt {mdata.uuid_string}: source: {mdata.source}"
             )
         else:
-            self._collector.logger.error(f"{mdata}")
+            self.collector.logger.error(f"{mdata}")
         #
         #
         #
@@ -277,7 +287,7 @@ class ErrorManager(Registrar, Listener):
             # if we are held by a CsvPath we are the CsvPath's error listener so we're
             # pushing the error back to our parent's public access interface.
             #
-            self._collector.collect_error(mdata)
+            self.collector.collect_error(mdata)
         if self.ecoms.do_i_stop() is True:
             if self.csvpath:
                 self.csvpath.stopped = True

{csvpath-0.0.598 → csvpath-0.0.599}/csvpath/managers/integrations/sftpplus/rpc.py

@@ -27,7 +27,7 @@ class Rpc:
             section="sftpplus",
             name="api_url",
             default="https://localhost:10020/json",
-            config=self.csvpaths.config,
+            config=self.csvpaths.config
         )
         result = self.send("login", username=self.username, password=self.password)
         self._session_id = result["session_id"]
@@ -37,6 +37,7 @@ class Rpc:
         if self._username is None:
             self._username = VarUtility.get(
                 section="sftpplus", name="admin_username", env="SFTPPLUS_ADMIN_USERNAME"
+                , config=self.csvpaths.config
             )
         return self._username
 
@@ -45,6 +46,7 @@ class Rpc:
         if self._password is None:
             self._password = VarUtility.get(
                 section="sftpplus", name="admin_password", env="SFTPPLUS_ADMIN_PASSWORD"
+                , config=self.csvpaths.config
             )
         return self._password
 

{csvpath-0.0.598 → csvpath-0.0.599}/csvpath/managers/integrations/sql/engine.py

@@ -1,30 +1,37 @@
 from sqlalchemy import create_engine, Engine
 
-# from sqlalchemy.orm import sessionmaker
 from csvpath.util.config import Config
 from csvpath.util.box import Box
 
 
 class Db:
     @classmethod
-    def get(self, config: Config) -> Engine:
+    def get(cls, config: Config) -> Engine:
+        dialect = config.get(section="sql", name="dialect")
+        conn = config.get(section="sql", name="connection_string")
+        return cls.get_engine(conn=conn, dialect=dialect)
+
+    @classmethod
+    def get_engine(cls, *, conn:str, dialect:str="sqlite") -> Engine:
         box = Box()
         engine = box.get(key=Box.SQL_ENGINE)
         if engine is None:
-            dialect = config.get(section="sql", name="dialect")
-            c_str = config.get(section="sql", name="connection_string")
+            #
+            # atm there's nothing different about the dialects, but we'll
+            # leave the ifs just for docs purposes.
+            #
             if dialect == "sqlite":
                 # sqlite:///example.db
-                engine = create_engine(c_str)
+                engine = create_engine(conn)
             elif dialect == "postgres":
                 # postgresql+psycopg2://user:password@localhost/dbname
-                engine = create_engine(c_str)
+                engine = create_engine(conn)
             elif dialect == "mysql":
                 # mysql+pymysql://user:password@localhost/dbname
-                engine = create_engine(c_str)
+                engine = create_engine(conn)
             elif dialect == "sql_server":
                 # mssql+pyodbc://user:password@localhost/dbname
-                engine = create_engine(c_str)
+                engine = create_engine(conn)
             else:
                 raise ValueError("Unknown RDBMS dialect %s", dialect)
             box.add(Box.SQL_ENGINE, engine)