daplug-sql 1.0.0b1__tar.gz

daplug_sql-1.0.0b1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

daplug_sql-1.0.0b1/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: daplug-sql
+Version: 1.0.0b1
+Summary: Shared schema, merge, and SNS helpers powering daplug adapters.
+Home-page: https://github.com/dual/daplug-sql
+Author: Paul Cruse III
+Author-email: paulcruse3@gmail.com
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/dual/daplug-sql
+Project-URL: Documentation, https://github.com/dual/daplug-sql#readme
+Project-URL: Source Code, https://github.com/dual/daplug-sql
+Project-URL: Bug Reports, https://github.com/dual/daplug-sql/issues
+Project-URL: CI/CD, https://circleci.com/gh/dual/daplug-sql
+Keywords: daplug,schema,sns,event-driven,database,adapter,python-library
+Platform: any
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3>=1.34
+Requires-Dist: daplug-core>=0.1.0
+Requires-Dist: mysql-connector-python>=8.3
+Requires-Dist: jsonref>=0.2
+Requires-Dist: psycopg2-binary>=2.9
+Requires-Dist: PyYAML>=5.3
+Requires-Dist: simplejson>=3.17
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 🔗 daplug-sql (da•plug)
+
+> **Schema-Driven SQL Normalization & Event Publishing for Python**
+
+[![CircleCI](https://circleci.com/gh/dual/daplug-sql.svg?style=shield)](https://circleci.com/gh/dual/daplug-sql)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-sql&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dual_daplug-sql)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-sql&metric=bugs)](https://sonarcloud.io/summary/new_code?id=dual_daplug-sql)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-sql&metric=coverage)](https://sonarcloud.io/summary/new_code?id=dual_daplug-sql)
+[![Python](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
+[![PyPI package](https://img.shields.io/pypi/v/daplug-sql?color=blue&label=pypi%20package)](https://pypi.org/project/daplug-sql/)
+[![License](https://img.shields.io/badge/license-apache%202.0-blue)](LICENSE)
+[![Contributions](https://img.shields.io/badge/contributions-welcome-blue)](https://github.com/paulcruse3/daplug-sql/issues)
+
+`daplug-sql` wraps psycopg2 / mysql-connector with optimistic CRUD helpers and SNS event fan-out so your Postgres and MySQL services stay DRY and event-driven.
+
+> 📎 **Agents** – a dedicated playbook lives in [`.agents/AGENTS.md`](.agents/AGENTS.md).
+
+---
+
+## ✨ Key Features
+
+- **Single adapter factory** – `daplug_sql.adapter(**kwargs)` returns a ready-to-go adapter configured for Postgres or MySQL based on the `engine` parameter.
+- **Optimistic CRUD** – Identifier-aware `insert`, `update`, `upsert`, and `delete` guard against duplicates and emit SNS events automatically.
+- **Connection reuse** – Thread-safe cache reuses connections per endpoint/database/user/port/engine and lazily closes them.
+- **Integration-tested** – `pipenv run integration` spins up both Postgres and MySQL via docker-compose and runs the real test suite.
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install daplug-sql
+# pipenv install daplug-sql
+# poetry add daplug-sql
+# uv pip install daplug-sql
+```
+
+### Minimal Example
+
+```python
+from daplug_sql import adapter
+
+sql = adapter(
+    endpoint="127.0.0.1",
+    database="daplug",
+    user="svc",
+    password="secret",
+    engine="postgres",  # "mysql" also supported
+)
+
+sql.connect()
+sql.insert(
+    data={"customer_id": "abc123", "name": "Ada"},
+    table="customers",
+    identifier="customer_id",
+)
+record = sql.get("abc123", table="customers", identifier="customer_id")
+print(record)
+sql.close()
+```
+
+---
+
+## ⚙️ Configuration
+
+| Parameter            | Type    | Required | Description                                                                 |
+|----------------------|---------|----------|-----------------------------------------------------------------------------|
+| `endpoint`           | `str`   | ✅       | Host/IP of the Postgres/MySQL server.                                       |
+| `database`           | `str`   | ✅       | Database/schema name.                                                       |
+| `user`               | `str`   | ✅       | Database username.                                                          |
+| `password`           | `str`   | ✅       | Database password.                                                          |
+| `engine`             | `str`   | ➖       | `'postgres'` (default) or `'mysql'`.                                        |
+| `autocommit`         | `bool`  | ➖       | Defaults to `True`; set `False` for manual transaction control.             |
+| `sns_arn`            | `str`   | ➖       | SNS topic ARN used when publishing CRUD events.                              |
+| `sns_endpoint`       | `str`   | ➖       | Optional SNS endpoint URL (e.g., LocalStack).                               |
+| `sns_attributes`     | `dict`  | ➖       | Default SNS message attributes merged into every publish.                    |
+
+### Per-Call Options
+
+Every CRUD/query helper expects the target table and identifier column at call time so one adapter can manage multiple tables:
+
+| Argument       | Description                                            |
+|----------------|--------------------------------------------------------|
+| `table`        | Table to operate on (`customers`, `orders`, etc.).      |
+| `identifier`   | Column that uniquely identifies rows (`customer_id`).   |
+| `commit`       | Override `autocommit` per call (`True`/`False`).        |
+| `debug`        | Log SQL statements via the adapter logger when `True`.  |
+| `sns_attributes` | Per-call attributes merged with defaults before publish. |
+| `fifo_group_id` / `fifo_duplication_id` | Optional FIFO metadata passed straight to SNS. |
+
+### SNS Publishing
+
+`SQLAdapter` inherits daplug-core's SNS publisher. Provide the topic details when constructing the adapter:
+
+```python
+sql = adapter(
+    endpoint="127.0.0.1",
+    database="daplug",
+    user="svc",
+    password="secret",
+    engine="postgres",
+    sns_arn="arn:aws:sns:us-east-1:123456789012:sql-events",
+    sns_endpoint="http://localhost:4566",  # optional (LocalStack)
+    sns_attributes={"service": "billing"},
+)
+```
+
+- `sns_attributes` passed to `adapter(...)` become defaults for every publish.
+- Each CRUD helper accepts its own `sns_attributes` to overlay call-specific metadata.
+- FIFO topics are supported via the `fifo_group_id` and `fifo_duplication_id` kwargs on individual calls.
+
+Example:
+
+```python
+sql.insert(
+    data={"customer_id": "abc123", "name": "Ada"},
+    table="customers",
+    identifier="customer_id",
+    sns_attributes={"event": "customer-created"},
+    fifo_group_id="customers",
+)
+```
+
+If `sns_arn` is omitted, publish calls are skipped automatically.
+
+---
+
+## 🧭 Public API Cheat Sheet
+
+| Method                     | Description                                                                                                   |
+|----------------------------|---------------------------------------------------------------------------------------------------------------|
+| `connect()`                                         | Opens a connection + cursor using the engine-specific connector.                                   |
+| `close()`                                           | Closes the cursor/connection and evicts the cached connector.                                       |
+| `commit(commit=True)`                               | Commits the underlying DB connection when `commit` is truthy.                                      |
+| `insert(data, table, identifier, **kwargs)`         | Validates data, enforces uniqueness on the provided identifier, inserts the row, and publishes SNS. |
+| `update(data, table, identifier, **kwargs)`         | Fetches the existing row, merges via `dict_merger`, runs `UPDATE`, publishes SNS.                   |
+| `upsert(data, table, identifier, **kwargs)`         | Calls `update` when the row exists; falls back to `insert`.                                        |
+| `get(identifier_value, table, identifier, **kwargs)`| Returns the first matching row or `None`.                                                         |
+| `read(identifier_value, table, identifier, **kwargs)`| Alias of `get`.                                                                                   |
+| `query(query, params, table, identifier, **kwargs)` | Executes a read-only statement (SELECT) and returns all rows as dictionaries.                       |
+| `delete(identifier_value, table, identifier, **kwargs)` | Deletes the row, publishes SNS, and ignores missing rows.                                     |
+| `create_index(table_name, index_columns)`           | Issues `CREATE INDEX index_col1_col2 ON table_name (col1, col2)` using safe identifiers.            |
+
+> All identifier-based helpers sanitize names with `SAFE_IDENTIFIER` to prevent SQL injection through table/column inputs.
+
+---
+
+## 📚 Usage Examples
+
+### Insert + Query (Postgres)
+
+```python
+sql = adapter(
+    endpoint="127.0.0.1",
+    database="daplug",
+    user="svc",
+    password="secret",
+    engine="postgres",
+)
+sql.connect()
+
+sql.insert(data={"sku": "W-1000", "name": "Widget", "cost": 99}, table="inventory", identifier="sku")
+rows = sql.query(
+    query="SELECT sku, name FROM inventory WHERE cost >= %(min_cost)s",
+    params={"min_cost": 50},
+    table="inventory",
+    identifier="sku",
+)
+print(rows)
+sql.close()
+```
+
+### Transactions (MySQL)
+
+```python
+sql = adapter(
+    endpoint="127.0.0.1",
+    database="daplug",
+    user="svc",
+    password="secret",
+    engine="mysql",
+    autocommit=False,
+)
+sql.connect()
+
+try:
+    sql.insert(data={"order_id": "O-1", "status": "pending"}, table="orders", identifier="order_id", commit=False)
+    sql.update(data={"order_id": "O-1", "status": "shipped"}, table="orders", identifier="order_id", commit=False)
+    sql.commit(True)
+finally:
+    sql.close()
+```
+
+### Per-call Table Overrides
+
+```python
+# Share one adapter across multiple tables by overriding table + identifier per call
+sql.insert(data=payload, table="orders", identifier="order_id")
+sql.create_index("orders", ["status", "created_at"])
+```
+
+---
+
+## 🧪 Testing & Tooling
+
+| Command                   | Description                                                                 |
+|---------------------------|-----------------------------------------------------------------------------|
+| `pipenv run lint`         | Runs pylint and exports HTML/JSON to `coverage/lint`.                       |
+| `pipenv run type-check`   | Runs mypy using the new Protocol types.                                     |
+| `pipenv run test`         | Executes the unit suite (mocks only).                                       |
+| `pipenv run integration`  | Starts Postgres + MySQL via docker-compose and runs `tests/integration`.    |
+| `pipenv run test_ci`      | Runs unit tests and integration tests sequentially (no Docker management). |
+| `pipenv run coverage`     | Full coverage run producing HTML, XML, JUnit, and pretty reports.          |
+
+Integration tests rely on `tests/integration/docker-compose.yml`. The CircleCI pipeline mirrors this by launching Postgres and MySQL sidecars, waiting for them to be reachable, and then executing `pipenv run coverage` so artifacts are published automatically.
+
+---
+
+## 🗂 Project Layout
+
+```txt
+daplug-sql/
+├── daplug_sql/
+│   ├── adapter.py           # SQLAdapter implementation
+│   ├── exception.py         # Adapter-specific exceptions
+│   ├── sql_connector.py     # Engine-aware connector wrapper
+│   ├── sql_connection.py    # Connection caching decorators
+│   ├── types/__init__.py    # Shared typing helpers (Protocols, aliases)
+│   └── __init__.py          # Adapter factory export
+├── tests/
+│   ├── unit/                # Pure unit tests (mocks only)
+│   └── integration/         # Integration tests (Postgres + MySQL)
+├── tests/integration/docker-compose.yml
+├── Pipfile / Pipfile.lock   # Runtime + dev dependencies
+├── setup.py                 # Packaging metadata
+├── README.md
+└── .agents/AGENTS.md        # Automation/Triage playbook for agents
+```
+
+---
+
+## 🤝 Contributing
+
+1. Fork / branch (`git checkout -b feature/amazing`)
+2. `pipenv install --dev`
+3. Add/change code + tests
+4. Run `pipenv run lint && pipenv run type-check && pipenv run test && pipenv run integration`
+5. Open a pull request and tag `@dual`
+
+---
+
+## 📄 License
+
+Apache License 2.0 – see [LICENSE](LICENSE).
+
+---
+
+Built to keep SQL integrations event-driven and zero-boilerplate.