pychestrate-core 0.0.1__tar.gz

pychestrate_core-0.0.1/LICENSE.md

@@ -0,0 +1,204 @@
+# Code Craft AI - Source Available License
+Version 1.0, October 2026
+
+Copyright (C) 2026, Code Craft AI LLC
+
+Everyone is permitted to copy and distribute verbatim copies of *This License* document, but changing it is not allowed.
+
+*This License* covers the Python Automation Kit, the full suite of software published by *Licensor* that consists of every `codecraftai-*` package, every `pychestrate` package, and the `pychestrate` server.
+
+*The Software* is source available.  Its source code is published so that anyone can read it, learn from it, and use it, but *This License* is not an open source license.  *The Software* is free to use for *Non-Commercial Use*.  *Commercial Use* is permitted in exchange for a *Usage Fee* that is based on a reasonable estimation of the income derived from *The Software*, as described in section 5.  When a company migrates a product or service to *The Software* from another code base, the *Profit* from that product or service is not counted toward the *Usage Fee* for two years, as described in section 5.4.  For assurance of costs, a company can disclose its usage and estimated returns to *Licensor* and negotiate a fixed license cost, as described in section 5.10.
+
+## 1. Definitions
+
+### 1.1 *This License* or *The License*
+**This License** or **The License** refers to version 1.0 of the Code Craft AI - Source Available License.
+
+### 1.2 Licensor
+**Licensor** refers to Code Craft AI LLC.
+
+### 1.3 The Software
+**The Software** refers to the Python Automation Kit, the full suite of software that *Licensor* publishes under *This License*.  The Python Automation Kit consists of the following components (each, a **Component**), together with their source code, documentation, and other materials:
+
+1. Every Python package published by *Licensor* whose name begins with `codecraftai-`
+2. Every Python package published by *Licensor* whose name begins with `pychestrate`
+3. The `pychestrate` server
+
+### 1.4 You
+**You** refers to the individual or legal entity that exercises rights under *This License*.  When an individual exercises rights under *This License* on behalf of a company, organization, or other legal entity, **You** refers to that entity.
+
+### 1.5 Use
+**Use** means to install, execute, load, access, operate, display, copy, modify, configure, customize, and otherwise use.
+
+### 1.6 Non-Commercial Use
+**Non-Commercial Use** means any *Use* of *The Software* that is not *Commercial Use*.  Examples of *Non-Commercial Use* include personal use, hobby projects, study, teaching, academic research, evaluation, and use by a non-profit organization for its non-profit purposes.
+
+### 1.7 Commercial Use
+**Commercial Use** means any *Use* of *The Software* by or on behalf of a for-profit entity, and any *Use* of *The Software* in connection with a product, service, or activity that generates revenue.  *Commercial Use* includes, without limitation, *Use* of *The Software* to develop, build, test, validate, deploy, operate, or support commercial products and services, and *Use* of *The Software* to provide services to others.
+
+### 1.8 Commercial Activity
+**Commercial Activity** means the products, services, and business operations in connection with which *You* make *Commercial Use* of *The Software*.
+
+### 1.9 Fiscal Year
+**Fiscal Year** means the annual accounting period that *You* use for financial reporting.
+
+### 1.10 Profit
+**Profit** means the net profit that *You* earn from the *Commercial Activity* during a *Fiscal Year*, determined under the accounting principles that *You* regularly use for financial reporting.
+
+### 1.11 Contribution Estimate
+**Contribution Estimate** means *Your* reasonable, good faith estimate of the portion of the *Profit* that *The Software* contributed to, expressed as a number from 0 to 1.
+
+### 1.12 Derived Income
+**Derived Income** means the portion of the *Profit* for a *Fiscal Year* that is derived from *The Software*, calculated as described in section 5.2.
+
+### 1.13 Usage Fee
+**Usage Fee** means the yearly fee for *Commercial Use* that is set by the table in section 5.3.
+
+### 1.14 Migration
+**Migration** means moving the work for one of *Your* products or services from a code base other than *The Software*, such as another framework, another library, or *Your* own code, to *The Software*.
+
+### 1.15 Migration Period
+**Migration Period** means the two (2) year period, described in section 5.4, during which the *Profit* from a product or service that *You* are migrating to *The Software* is not counted.
+
+## 2. License Grant
+
+Subject to the terms and conditions of *This License*, *Licensor* hereby grants to *You* a non-exclusive, worldwide, non-transferable license to *Use*, copy, modify, create derivative works of, and distribute *The Software*.
+
+*Licensor* also grants to *You* a license under any patents that *Licensor* can license, and that are necessarily infringed by *The Software*, for the same purposes and subject to the same conditions as the license granted above.
+
+*This License* covers the Python Automation Kit as a whole.  *Use* of one, some, or all of the *Components* is *Use* of *The Software*.
+
+The licenses granted by *This License* are free of charge for *Non-Commercial Use*.  The licenses granted by *This License* for *Commercial Use* are conditioned on the payment of the *Usage Fee* described in section 5.
+
+## 3. Conditions
+
+### 3.1 License Notice
+Every copy of *The Software* that *You* distribute, in original or modified form, must include a complete copy of *This License* and must keep all copyright, patent, trademark, and attribution notices that appear in *The Software*.
+
+### 3.2 Recipients
+Anyone who receives *The Software* from *You* receives it under the terms of *This License*.  *You* may not impose terms on a recipient that conflict with *This License*, and *You* may not grant a recipient rights that *This License* does not grant to *You*.
+
+### 3.3 Modified Versions
+*You* must clearly mark any modified version of *The Software* as modified.  *The Software* is published by *Licensor* under a specific identity, such as a package name.  *You* may not publish a modified version of *The Software* under the identity that *Licensor* originally published it under.  Every copy of *The Software* that *You* redistribute under its original identity must be an exact copy of *The Software* as *Licensor* published it.
+
+### 3.4 Trademarks
+*This License* does not grant any rights to use the names, logos, or trademarks of *Licensor*, except as required to comply with section 3.1 and to describe the origin of *The Software*.
+
+## 4. Non-Commercial Use
+
+*Non-Commercial Use* of *The Software* is free.  No *Usage Fee*, registration, or report is required for *Non-Commercial Use*.
+
+## 5. Commercial Use
+
+### 5.1 Usage Fee Obligation
+For each *Fiscal Year* in which *You* make *Commercial Use* of *The Software*, *You* must pay *Licensor* a *Usage Fee*.  A single *Usage Fee* covers all of *Your* *Commercial Use* of the *Components*.  *Usage Fees* are not owed separately for each *Component*.
+
+### 5.2 Derived Income
+The *Derived Income* for a *Fiscal Year* is calculated as follows:
+
+    (Contribution Estimate) * (Profit) = (Derived Income)
+
+If *You* make *Commercial Use* of *The Software* for more than one product or service, calculate the *Derived Income* for each product or service using its own *Contribution Estimate* and *Profit*, and add the results together.  The *Profit* from a product or service that is in its *Migration Period* is not counted, as described in section 5.4.
+
+If the *Profit* from a product or service for a *Fiscal Year* is zero or less, then the *Derived Income* from that product or service for that *Fiscal Year* is zero.
+
+### 5.3 Usage Fee
+The *Usage Fee* for a *Fiscal Year* is set by the *Derived Income* for that *Fiscal Year*, as shown in the following table.
+
+| Derived Income for the Fiscal Year | Usage Fee per Fiscal Year |
+|------------------------------------|---------------------------|
+| 1,000,000 or less | Free |
+| More than 1,000,000, up to and including 10,000,000 | 50,000 |
+| More than 10,000,000, up to and including 100,000,000 | 100,000 |
+| More than 100,000,000, up to and including 1,000,000,000 | 250,000 |
+| More than 1,000,000,000 | 500,000 |
+
+All amounts in this section 5 are in United States dollars.  If *You* report *Profit* in a different currency, convert the *Derived Income* to United States dollars using the average exchange rate for the *Fiscal Year*.
+
+### 5.4 Migration Allowance
+When *You* migrate a product or service to *The Software*, the *Profit* from that product or service is not counted when calculating the *Derived Income* during its *Migration Period* (the **Migration Allowance**).
+
+The *Migration Period* for a product or service begins on the date that *You* first make *Commercial Use* of *The Software* for that product or service as part of its *Migration*, and ends two (2) years after that date.
+
+The *Migration Allowance* applies to each product or service separately, and *You* may use it for every product or service that *You* migrate.  Each product or service has only one *Migration Period*.
+
+If a *Fiscal Year* is only partly within the *Migration Period* of a product or service, the *Profit* from that product or service for that *Fiscal Year* is reduced in proportion to the number of days of that *Fiscal Year* that fall within its *Migration Period*.
+
+For example, a company tests product A with *The Software* and pays a *Usage Fee* based on the *Profit* from product A.  On March 1, 2027, the company begins moving the testing of product B from a different test framework to *The Software*.  The company does not count the *Profit* from product B in its *Derived Income* from March 1, 2027 until March 1, 2029.  Starting March 1, 2029, the *Profit* from product B is counted.  If the company later migrates product C, the *Profit* from product C is not counted for two years from the start of its own *Migration*.
+
+### 5.5 Contribution Estimate
+*You* are responsible for making the *Contribution Estimate*.  A *Contribution Estimate* must be reasonable and made in good faith.  The *Contribution Estimate* for a product or service covers all of the *Components* that *You* *Use* for that product or service.  When making the *Contribution Estimate*, *You* should consider how important *The Software* is to the *Commercial Activity*, how much of the *Commercial Activity* depends on *The Software*, and the effort and cost that *You* would otherwise need to spend to accomplish what *The Software* accomplishes for *You*.
+
+The following table is a guide for making the *Contribution Estimate*.  When *Your* *Commercial Use* of *The Software* matches an entry in the table, the *Contribution Estimate* in that entry is a reasonable *Contribution Estimate*.  When *Your* *Commercial Use* does not match an entry in the table, make the *Contribution Estimate* by comparing *Your* *Commercial Use* with the entries in the table.  When more than one entry matches the same *Commercial Activity*, use the entry with the highest *Contribution Estimate*.
+
+| Commercial Use of *The Software* | Contribution Estimate |
+|----------------------------------|-----------------------|
+| Quality Assurance (QA) and Continuous Integration (CI): *The Software* is used to test or validate the products or services of the *Commercial Activity*, or to run their build and test pipelines | 0.3 |
+| Products Completely Based on *The Software*: the products or services of the *Commercial Activity* are built completely on *The Software* | 0.5 |
+
+### 5.6 Examples
+A company earns 1,000,000,000 in *Profit* from a product line during a *Fiscal Year*.  The company uses *The Software* for the QA and CI of that product line, so the *Contribution Estimate* is 0.3.
+
+    0.3 * 1,000,000,000 = 300,000,000
+
+The *Derived Income* of 300,000,000 is more than 100,000,000 and not more than 1,000,000,000, so the *Usage Fee* for that *Fiscal Year* is 250,000.
+
+A company earns 4,000,000 in *Profit* from a product during a *Fiscal Year*.  The product is built completely on *The Software*, so the *Contribution Estimate* is 0.5.
+
+    0.5 * 4,000,000 = 2,000,000
+
+The *Derived Income* of 2,000,000 is more than 1,000,000 and not more than 10,000,000, so the *Usage Fee* for that *Fiscal Year* is 50,000.
+
+A company earns 3,000,000 in *Profit* from a product line during a *Fiscal Year*.  The company uses *The Software* for the QA and CI of that product line, so the *Contribution Estimate* is 0.3.
+
+    0.3 * 3,000,000 = 900,000
+
+The *Derived Income* of 900,000 is 1,000,000 or less, so there is no *Usage Fee* for that *Fiscal Year*.
+
+### 5.7 Reporting and Payment
+Within one hundred twenty (120) days after the end of each *Fiscal Year* for which a *Usage Fee* is owed, *You* must pay the *Usage Fee* to *Licensor* and provide *Licensor* with a written statement that shows the *Profit*, the *Contribution Estimate*, the reasoning used to make the *Contribution Estimate*, the *Derived Income*, and the *Usage Fee*.  *Usage Fees* are payable in United States dollars.  If any *Profit* is not counted under section 5.4, the statement must also identify each product or service that is in a *Migration Period* and show the dates of its *Migration Period*.  No statement is required for a *Fiscal Year* in which no *Usage Fee* is owed.
+
+### 5.8 Records and Review
+*You* must keep records that reasonably support each *Contribution Estimate*, each *Profit* figure, and the dates of any *Migration Period* for at least three (3) years after the end of the *Fiscal Year* that they apply to.  No more than once in any twelve (12) month period, *Licensor* may ask in writing for the records that support a statement, and *You* must provide them within sixty (60) days of the request.  *Licensor* will treat those records as confidential.
+
+### 5.9 Disputes About the Usage Fee
+If *Licensor* believes that a *Contribution Estimate*, a *Profit* figure, or the dates of a *Migration Period* are not reasonable, *Licensor* will notify *You* in writing and explain why.  *You* and *Licensor* will then negotiate in good faith for at least sixty (60) days to agree on a reasonable *Usage Fee*.  If *You* and *Licensor* cannot agree, either party may resolve the dispute as described in section 8.
+
+### 5.10 Fixed License Cost
+For assurance of costs, *You* may disclose to *Licensor* how *You* *Use* *The Software* and the returns that *You* estimate *You* will derive from it, and negotiate a fixed license cost with *Licensor*.  A fixed license cost, and any other terms that *You* and *Licensor* agree to, must be set out in a writing signed by both *You* and *Licensor* (a **Fixed License Agreement**).
+
+While a *Fixed License Agreement* is in effect, the fixed license cost replaces the *Usage Fee* for the *Commercial Use* that the *Fixed License Agreement* covers, and sections 5.7 through 5.9 apply to that *Commercial Use* only as the *Fixed License Agreement* provides.  To the extent that a *Fixed License Agreement* conflicts with this section 5, the *Fixed License Agreement* controls.
+
+*Licensor* will treat the information that *You* disclose under this section 5.10 as confidential.
+
+## 6. Termination
+
+If *You* violate *This License*, the licenses granted to *You* by *This License* end.  If *Licensor* notifies *You* in writing of the violation and *You* correct the violation within thirty (30) days of receiving the notice, including by paying any *Usage Fee* that is owed, then the licenses granted to *You* are reinstated.  This reinstatement is available to *You* only once.  Termination does not release *You* from any *Usage Fee* that is owed for *Commercial Use* that took place before the termination.
+
+## 7. No Warranty and Limitation of Liability
+
+### 7.1 No Warranty
+*THE SOFTWARE* IS PROVIDED "AS IS", WITHOUT ANY WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, TITLE, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
+
+### 7.2 Limitation of Liability
+TO THE EXTENT PERMITTED BY LAW, IN NO EVENT WILL *LICENSOR* BE LIABLE TO *YOU* FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR EXEMPLARY DAMAGES OF ANY KIND ARISING OUT OF OR RELATED TO *THIS LICENSE* OR THE *USE* OF *THE SOFTWARE*, EVEN IF *LICENSOR* HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+### 7.3 Support
+*This License* does not entitle *You* to support, maintenance, or other services.  Support and services are available only under a separate written agreement with *Licensor*.
+
+## 8. Governing Law and Jurisdiction
+
+*This License* is governed by the laws of the State of Washington and the United States as though fully performed in Washington, without regard to provisions relating to conflicts of laws.  The UN Convention for the International Sale of Goods and the Uniform Computer Information Transactions Act (UCITA) will not apply.  The state and federal courts located in King County, Washington will have exclusive jurisdiction to adjudicate any disputes arising under *This License*, and *You* and *Licensor* agree to submit to the jurisdiction of those courts.
+
+## 9. General
+
+### 9.1 Severability
+If any provision of *This License* is held to be unenforceable, that provision will be enforced to the maximum extent permitted, and the remaining provisions of *This License* will remain in effect.
+
+### 9.2 Interpretation
+The section headings in *This License* are for reference purposes only and do not modify or restrict any term of *This License*.  *This License* is written in the English language, and the English text prevails over any translation.
+
+### 9.3 Contact
+Questions about *This License*, *Usage Fee* statements, payments, and requests to negotiate a *Fixed License Agreement* may be sent to *Licensor* using the contact information published at:
+
+    https://code-craft.ai

pychestrate_core-0.0.1/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: pychestrate-core
+Version: 0.0.1
+Summary: Code Craft AI - Pychestrate - Core
+License: LicenseRef-CodeCraftAI-Source-Available
+License-File: LICENSE.md
+Keywords: python
+Requires-Python: >=3.10,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+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: Programming Language :: Python :: 3.15
+Requires-Dist: codecraftai-configuration (>=1.0.0,<2.0.0)
+Requires-Dist: codecraftai-credentials (>=1.0.0,<2.0.0)
+Requires-Dist: codecraftai-dataprofiles (>=1.0.0,<2.0.0)
+Requires-Dist: codecraftai-foundations (>=1.0.0,<2.0.0)
+Requires-Dist: codecraftai-runtime (>=1.0.0,<2.0.0)
+Requires-Dist: codecraftai-testbase (>=1.0.0,<2.0.0)
+Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Requires-Dist: sqlalchemy (>=2.0.30,<3.0.0)
+Requires-Dist: sqlalchemy-utils (>=0.41.2,<0.43.0)
+Description-Content-Type: text/x-rst
+
+==================
+Pychestrate - Core
+==================
+
+The 'Pychestrate' core package contains common/shared types and code such as data models and interfaces.
+
+=================
+Code Organization
+=================
+* .vscode - Common tasks
+* development - This is where the runtime environment scripts are located
+* repository-setup - Scripts for homing your repository and to your checkout and machine setup
+* userguide - Where you put your user guide
+* source/packages - Put your root folder here 'source/packages/(root-module-folder)'
+* source/sphinx - This is the Sphinx documentation folder
+* workspaces - This is where you add VSCode workspaces templates and where workspaces show up when homed.
+
+==========
+References
+==========
+
+- `Contributing <userguide/contributing.rst>`
+- `Coding Standards <https://github.com/code-craft-ai-company/pychestrate-service/blob/main/userguide/10-00-coding-standards.rst>`_ (kept once, in pychestrate-service)
+

pychestrate_core-0.0.1/README.rst

@@ -0,0 +1,23 @@
+==================
+Pychestrate - Core
+==================
+
+The 'Pychestrate' core package contains common/shared types and code such as data models and interfaces.
+
+=================
+Code Organization
+=================
+* .vscode - Common tasks
+* development - This is where the runtime environment scripts are located
+* repository-setup - Scripts for homing your repository and to your checkout and machine setup
+* userguide - Where you put your user guide
+* source/packages - Put your root folder here 'source/packages/(root-module-folder)'
+* source/sphinx - This is the Sphinx documentation folder
+* workspaces - This is where you add VSCode workspaces templates and where workspaces show up when homed.
+
+==========
+References
+==========
+
+- `Contributing <userguide/contributing.rst>`
+- `Coding Standards <https://github.com/code-craft-ai-company/pychestrate-service/blob/main/userguide/10-00-coding-standards.rst>`_ (kept once, in pychestrate-service)

pychestrate_core-0.0.1/pyproject.toml

@@ -0,0 +1,38 @@
+[tool.poetry]
+name = "pychestrate-core"
+description = "Code Craft AI - Pychestrate - Core"
+version = "0.0.1"
+authors = []
+readme = "README.rst"
+license = "LicenseRef-CodeCraftAI-Source-Available"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: Other/Proprietary License",
+    "Operating System :: POSIX"
+]
+keywords = [
+    "python"
+]
+packages = [{include="ccai", from="source/packages"}]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+pyyaml = "^6.0.2"
+psycopg2-binary = "^2.9.9"
+sqlalchemy = "^2.0.30"
+sqlalchemy-utils = ">=0.41.2,<0.43.0"
+codecraftai-foundations = ">=1.0.0,<2.0.0"
+codecraftai-configuration = ">=1.0.0,<2.0.0"
+codecraftai-runtime = ">=1.0.0,<2.0.0"
+codecraftai-credentials = ">=1.0.0,<2.0.0"
+codecraftai-dataprofiles = ">=1.0.0,<2.0.0"
+codecraftai-testbase = ">=1.0.0,<2.0.0"
+
+
+
+[tool.poetry.group.dev.dependencies]
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pychestrate_core-0.0.1/source/packages/ccai/pychestrate/core/examples/create_database.py

@@ -0,0 +1,52 @@
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Automation Mojo LLC"
+__credits__ = []
+__version__ = "1.0.0"
+
+from ccai.runtime.activation import activate_runtime, ActivationProfile
+
+from ccai.configuration.configurationmaps import resolve_configuration_maps
+from ccai.configuration.configurationsettings import establish_configuration_settings
+from ccai.configuration.configurationvariables import resolve_configuration_variables
+
+
+from ccai.credentials.wellknown import CredentialManagerSingleton
+
+from ccai.dataprofiles.wellknown import DataProfileManagerSingleton
+
+
+from ccai.pychestrate.core.storage.dbconnection import create_database_connection_factory
+from ccai.pychestrate.core.storage.dbio import database_exists, database_create
+from ccai.pychestrate.core.storage.orm import PychestrateModelBase
+
+
+def create_database_main():
+
+    establish_configuration_settings(name="pychestrate", presence_dir="~/pychestrate")
+
+    resolve_configuration_variables()
+
+    activate_runtime(profile=ActivationProfile.Command)
+
+    resolve_configuration_maps(use_credentials=True, use_landscape=True)
+
+    profile_manager = DataProfileManagerSingleton()
+    dbprofile = profile_manager.lookup_profile("software-pipeline-admin")
+
+    cred_manager = CredentialManagerSingleton()
+
+    dbfactory = create_database_connection_factory(dbprofile=dbprofile, cred_manager=cred_manager)
+
+    dbname = "pipeline"
+
+    if not database_exists(dbfactory, dbname):
+        database_create(dbfactory, dbname=dbname, dbmetadata=PychestrateModelBase.metadata)
+
+    return
+
+
+if __name__ == "__main__":
+
+    create_database_main()
+

pychestrate_core-0.0.1/source/packages/ccai/pychestrate/core/storage/dbconnection.py

@@ -0,0 +1,269 @@
+"""
+.. module:: dbconnection
+    :platform: Darwin, Linux, Unix, Windows
+    :synopsis: Contains helper functions for working with specific databases
+
+.. moduleauthor:: Myron Walker <myron.walker@gmail.com>
+"""
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Automation Mojo LLC"
+__credits__ = []
+__version__ = "1.0.0"
+
+from typing import Optional
+
+import logging
+import os
+
+from sqlalchemy import create_engine
+from sqlalchemy.engine.base import Engine as SqlEngine
+
+from ccai.errors.exceptions import ConfigurationError
+
+from ccai.credentials.basecredential import BaseCredential
+from ccai.credentials.basiccredential import BasicCredential
+from ccai.credentials.credentialmanager import CredentialManager
+
+from ccai.dataprofiles.databasebasicsocketprofile import DatabaseBasicSocketProfile
+from ccai.dataprofiles.databasebasictcpprofile import DatabaseBasicTcpProfile
+
+
+logger = logging.getLogger()
+
+
+class DatabaseConnectionFactory:
+
+    def __init__(self, profile_name: str, *, dbprofile: DatabaseBasicSocketProfile, credential: BaseCredential):
+        self._profile_name = profile_name
+        self._dbprofile = dbprofile
+        self._credential = credential
+        return
+    
+    @property
+    def credential(self) -> BaseCredential:
+        return self._credential
+    
+    @property
+    def dbprofile(self) -> DatabaseBasicSocketProfile:
+        return self._dbprofile
+    
+    @property
+    def profile_name(self) -> str:
+        return self._profile_name
+
+    def create_engine(self, *, dbname=None, echo=True) -> SqlEngine:
+        errmsg = "The 'create_engine' method must be overloaded by 'DatabaseConnectionFactory' derived types."
+        raise NotImplementedError(errmsg)
+    
+    def format_connection_string() -> str:
+        errmsg = "The 'format_connection_string' method must be overloaded by 'DatabaseConnectionFactory' derived types."
+        raise NotImplementedError(errmsg)
+
+
+class BasicSocketDatabaseConnectionFactory(DatabaseConnectionFactory):
+
+    def __init__(self, profile_name: str, *, dbprofile: DatabaseBasicSocketProfile, credential: BaseCredential):
+        super().__init__(profile_name, dbprofile=dbprofile, credential=credential)
+        return
+
+    def create_engine(self, *, dbname=None, echo=True) -> SqlEngine:
+        """Create a SQLAlchemy engine using pipe based connectivity."""
+
+        socket_path: str = self.dbprofile.socket
+
+        if dbname is None and self.dbprofile.dbname is not None:
+            dbname = self.dbprofile.dbname
+
+        if dbname is None:
+            warnmsg = "BasicSocketDatabaseConnectionFactory.create_engine: dbname was None."
+            logger.warn(warnmsg)
+
+        if isinstance(self.credential, BasicCredential):
+            connstr = self.format_connection_string(dbname=dbname)
+            dbengine = create_engine(connstr, echo=echo)
+        else:
+            errmsg = (
+                "BasicSocketDatabaseConnectionFactory requires a BasicCredential to "
+                "create an engine."
+            )
+            raise ConfigurationError(errmsg)
+
+        return dbengine
+
+    def get_connection_scheme(self):
+        """Return the SQLAlchemy connection scheme for the profile."""
+
+        conn_scheme = None
+
+        if self.dbprofile.dbtype == "postgresql":
+            try:
+                import psycopg2  # noqa: F401
+            except ImportError:
+                errmsg_lines = [
+                    "In order to create a postgresql database engine, you must install the following dependencies.",
+                    "DEPENDENCIES",
+                    "    psycopg2",
+                ]
+                errmsg = os.linesep.join(errmsg_lines)
+                raise ConfigurationError(errmsg)
+
+            conn_scheme = "postgresql+psycopg2"
+
+        return conn_scheme
+
+    def format_connection_string(self, dbname: Optional[str] = None) -> str:
+        """Build a connection string for pipe based access."""
+
+        conn_scheme: str = self.get_connection_scheme()
+
+        socket_path: str = self.dbprofile.socket
+
+        if not isinstance(self.credential, BasicCredential):
+            errmsg = (
+                "BasicSocketDatabaseConnectionFactory requires a BasicCredential to "
+                "format the connection string."
+            )
+            raise ConfigurationError(errmsg)
+
+        credobj: BasicCredential = self.credential
+
+        username = credobj.username
+        password = credobj.password
+
+        if dbname is None:
+            dbname = self.dbprofile.dbname
+
+        conn_str = f"{conn_scheme}://{username}:{password}@/{dbname}?host={socket_path}"
+
+        return conn_str
+
+
+class BasicTcpDatabaseConnectionFactory(DatabaseConnectionFactory):
+
+    def __init__(self, profile_name: str, *, dbprofile: DatabaseBasicTcpProfile, credential: BaseCredential):
+        super().__init__(profile_name, dbprofile=dbprofile, credential=credential)
+        return
+
+    @property
+    def dbprofile(self) -> DatabaseBasicTcpProfile:
+        return self._dbprofile
+
+    def create_engine(self, *, dbname=None, echo=True) -> SqlEngine:
+
+        conn_scheme = None
+
+        # If the database type we are creating an engine for is postgresql, make sure
+        # we can import all of the postgresql dependencies.
+        if self.dbprofile.dbtype == 'postgresql':
+            try:
+                import psycopg2
+            except ImportError:
+                errmsg_lines = [
+                    "In order to create a postgresql database engine, you must install the following dependencies.",
+                    "DEPENDENCIES",
+                    "    psycopg2"
+                ]
+                errmsg = os.linesep.join(errmsg_lines)
+                raise ConfigurationError(errmsg)
+            
+            conn_scheme = "postgresql+psycopg2"
+
+        if dbname is None and self.dbprofile.dbname is not None:
+            dbname = self.dbprofile.dbname
+
+        if dbname is None:
+            warnmsg = "BasicTcpDatabaseConnectionFactory.create_engine: dbname was None."
+            logger.warn(warnmsg)
+
+        if isinstance(self.credential, BasicCredential):
+            credobj: BasicCredential = self.credential
+
+            passwd = credobj.password
+
+            connstr = self.format_connection_string(dbname=dbname)
+            
+            dbengine = create_engine(connstr, echo=echo)
+
+        return dbengine
+    
+    def get_connection_scheme(self):
+
+        conn_scheme = None
+
+        # If the database type we are creating an engine for is postgresql, make sure
+        # we can import all of the postgresql dependencies.
+        if self.dbprofile.dbtype == 'postgresql':
+            try:
+                import psycopg2
+            except ImportError:
+                errmsg_lines = [
+                    "In order to create a postgresql database engine, you must install the following dependencies.",
+                    "DEPENDENCIES",
+                    "    psycopg2"
+                ]
+                errmsg = os.linesep.join(errmsg_lines)
+                raise ConfigurationError(errmsg)
+            
+            conn_scheme = "postgresql+psycopg2"
+
+        return conn_scheme
+
+    def format_connection_string(self, dbname: Optional[str]=None) -> str:
+        
+        conn_str = None
+
+        conn_scheme: str = self.get_connection_scheme()
+        host: str = self.dbprofile.host
+        port: str = self.dbprofile.port
+        
+        if isinstance(self.credential, BasicCredential):
+            credobj: BasicCredential = self.credential
+
+            username = credobj.username
+            password = credobj.password
+
+            conn_str = f"{conn_scheme}://{username}:{password}@{host}:{port}"
+
+            if dbname is not None:
+                conn_str += f"/{dbname}"
+            else:
+                conn_str += f"/{self.dbprofile.dbname}"
+
+        return conn_str
+
+
+
+DATABASE_CONNECTION_FACTORIES = {}
+
+
+def create_database_connection_factory(dbprofile: DatabaseBasicSocketProfile, cred_manager: CredentialManager) -> DatabaseConnectionFactory:
+
+    global DATABASE_CONNECTION_FACTORIES
+
+    conn_factory = None
+
+    profile_name = dbprofile.identifier
+
+    if profile_name in DATABASE_CONNECTION_FACTORIES:
+        conn_factory = DATABASE_CONNECTION_FACTORIES[profile_name]
+    
+    else:
+
+        credential_name = dbprofile.credential
+
+        credential: BaseCredential = cred_manager.credentials[credential_name]
+
+        category = dbprofile.category
+        if category == "basic-socket":
+            conn_factory = BasicSocketDatabaseConnectionFactory(profile_name, dbprofile=dbprofile, credential=credential)
+        elif category == "basic-tcp":
+            conn_factory = BasicTcpDatabaseConnectionFactory(profile_name, dbprofile=dbprofile, credential=credential)
+        else:
+            errmsg = "Unknown database connection type. profile_name={} category={}".format(
+                profile_name, category)
+            raise ConfigurationError(errmsg)
+
+        DATABASE_CONNECTION_FACTORIES[profile_name] = conn_factory
+
+    return conn_factory