daplug-cypher 1.0.0b1__tar.gz

daplug_cypher-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_cypher-1.0.0b1/PKG-INFO

@@ -0,0 +1,377 @@
+Metadata-Version: 2.4
+Name: daplug-cypher
+Version: 1.0.0b1
+Summary: A Cypher and Neptune graph normalization layer inspired by Trellis data adapters.
+Home-page: https://github.com/dual/daplug-cypher
+Author: Paul Cruse III
+Author-email: paulcruse3@gmail.com
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/dual/daplug-cypher
+Project-URL: Documentation, https://github.com/dual/daplug-cypher#readme
+Project-URL: Source Code, https://github.com/dual/daplug-cypher
+Project-URL: Bug Reports, https://github.com/dual/daplug-cypher/issues
+Project-URL: CI/CD, https://circleci.com/gh/dual/daplug-cypher
+Keywords: cypher,neptune,graph,bolt,normalizer,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: jsonref>=0.2
+Requires-Dist: PyYAML>=5.3
+Requires-Dist: simplejson>=3.17
+Requires-Dist: cypher>=5.13
+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-cypher (da•plug)
+
+> **Schema-Driven Cypher Normalization & Event Publishing for Python**
+
+[![CircleCI](https://circleci.com/gh/dual/daplug-cypher.svg?style=shield)](https://circleci.com/gh/dual/daplug-cypher)
+[![Python](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
+[![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-cypher/issues)
+[![PyPI package](https://img.shields.io/pypi/v/daplug-cypher?color=blue&label=pypi%20package)](https://pypi.org/project/daplug-cypher/)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-cypher&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dual_daplug-cypher)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-cypher&metric=bugs)](https://sonarcloud.io/summary/new_code?id=dual_daplug-cypher)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-cypher&metric=coverage)](https://sonarcloud.io/summary/new_code?id=dual_daplug-cypher)
+
+`daplug-cypher` brings the ergonomics of  an adapter patthern to graph databases. It bundles Cypher-friendly schema mapping, optimistic concurrency, and SNS event fan-out so your graph services stay DRY, version-safe, and event-driven—whether you deploy to Neo4j or AWS Neptune (openCypher).
+
+## ✨ Key Features
+
+- **Unified factory** – `daplug_cypher.adapter(**kwargs)` returns a ready-to-go adapter with SNS support, just like `daplug_ddb`.
+- **Schema mapping** – Reuse OpenAPI/JSON schemas to validate and normalize payloads before writing nodes or relationships.
+- **Optimistic concurrency** – Guard updates with identifier + version keys; the adapter enforces atomic Cypher `SET` semantics.
+- **Relationship helpers** – Convenience methods that enforce safe Cypher patterns for creating/deleting relationships.
+- **Backend flexibility** – Supply `bolt={...}` for Neo4j, `neptune={...}` for Neptune, or both; the adapter chooses the right driver config automatically.
+- **Per-operation targeting** – Pass `node`, `identifier`, and `idempotence_key` to each call so shared adapters can manage multiple labels safely.
+- **Per-call SNS metadata** – Supply `sns_attributes` when writing to annotate events with request-specific context.
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install daplug-cypher
+# pipenv install daplug-cypher
+# poetry add daplug-cypher
+# uv pip install daplug-cypher
+```
+
+### Basic Usage
+
+```python
+from daplug_cypher import adapter
+
+graph = adapter(
+    bolt={
+        "url": "bolt://localhost:7687",
+        "user": "neo4j",
+        "password": "password",
+    },
+    schema_file="openapi.yml",
+    schema="CustomerModel",
+)
+
+payload = {
+    "customer_id": "abc123",
+    "name": "Ada",
+    "version": 1,
+}
+
+graph.create(data=payload, node="Customer")
+result = graph.read(
+    query="MATCH (c:Customer) WHERE c.customer_id = $id RETURN c",
+    placeholder={"id": "abc123"},
+    node="Customer",
+)
+
+print(result["Customer"][0]["name"])
+
+graph.create(
+    data=payload,
+    node="Customer",
+    sns_attributes={"source": "api"},
+)
+```
+
+Because the adapter is schema-aware, every write can opt into mapping by passing `schema`. Skip it when you want to persist the payload exactly as provided. Select the node label (and identifiers) per call so a single adapter can service multiple models, and add `sns_attributes` when you want to decorate published events with request-specific context.
+
+## 🔧 Advanced Configuration
+
+### Public API Cheat Sheet
+
+```python
+from daplug_cypher import adapter
+
+graph = adapter(bolt={"url": "bolt://localhost:7687", "user": "neo4j", "password": "password"})
+
+# CREATE ---------------------------------------------------------------
+graph.create(
+    data={"customer_id": "abc123", "name": "Ada", "version": 1},
+    node="Customer",
+    sns_attributes={"event": "customer-created"},
+)
+
+# READ / MATCH ---------------------------------------------------------
+graph.read(
+    query="MATCH (c:Customer) WHERE c.customer_id = $id RETURN c",
+    placeholder={"id": "abc123"},
+    node="Customer",
+)
+
+# QUERY (raw parameterized Cypher) ------------------------------------
+graph.query(
+    query="MATCH (c:Customer) WHERE c.customer_id = $id RETURN c",
+    placeholder={"id": "abc123"},
+    sns_attributes={"source": "reporting"},
+)
+
+# UPDATE (optimistic) --------------------------------------------------
+graph.update(
+    data={"status": "vip"},
+    query="MATCH (c:Customer) WHERE c.customer_id = $id RETURN c",
+    placeholder={"id": "abc123"},
+    original_idempotence_value=1,
+    node="Customer",
+    identifier="customer_id",
+    idempotence_key="version",
+    sns_attributes={"event": "customer-updated"},
+)
+
+# DELETE ---------------------------------------------------------------
+graph.delete(
+    delete_identifier="abc123",
+    node="Customer",
+    identifier="customer_id",
+    sns_attributes={"event": "customer-deleted"},
+)
+
+# RELATIONSHIP HELPERS -------------------------------------------------
+graph.create_relationship(
+    query="""
+        MATCH (c:Customer), (o:Order)
+        WHERE c.customer_id = $customer AND o.order_id = $order
+        CREATE (c)-[:PLACED]->(o)
+        RETURN c, o
+    """,
+    placeholder={"customer": "abc123", "order": "o-789"},
+    sns_attributes={"event": "relationship-created"},
+)
+
+graph.delete_relationship(
+    query="""
+        MATCH (c:Customer)-[r:PLACED]->(o:Order)
+        WHERE c.customer_id = $customer AND o.order_id = $order
+        DETACH DELETE r
+    """,
+    placeholder={"customer": "abc123", "order": "o-789"},
+    sns_attributes={"event": "relationship-deleted"},
+)
+```
+
+Each method mirrors the DynamoDB adapter API: provide per-call metadata, and the adapter handles schema normalization, optimistic locking, driver orchestration, and optional SNS fan-out.
+
+### Neo4j & Neptune Targets
+
+```python
+graph = adapter(
+    bolt={"url": "bolt://localhost:7687", "user": "neo4j", "password": "password"},
+    neptune={"url": "bolt://neptune-endpoint:8182", "user": "user", "password": "secret"},
+)
+```
+
+Provide both dictionaries to allow local Neo4j development with a production Neptune endpoint. When `neptune` is supplied it wins; otherwise `bolt` is used.
+Use the same adapter instance for different node types by passing the appropriate label to each call (e.g., `graph.create(..., node="Order")`).
+
+### Optimistic Updates
+
+```python
+graph.update(
+    data={"order_id": "abc123", "updated_at": 2, "status": "shipped"},
+    query="MATCH (o:Order) WHERE o.order_id = $id RETURN o",
+    placeholder={"id": "abc123"},
+    original_idempotence_value=1,  # the previous value of updated_at
+    node="Order",
+    identifier="order_id",
+    idempotence_key="updated_at",
+    sns_attributes={"event": "status-change"},
+)
+```
+
+If another session updates the node first, the adapter raises `ValueError("ATOMIC ERROR...")` rather than overwriting silently.
+
+### Relationship Helpers
+
+```python
+graph.create(data={"customer_id": "abc123", "version": 1}, node="Customer")
+graph.create(data={"order_id": "o-789", "version": 1}, node="Order")
+
+graph.create_relationship(
+    query="""
+        MATCH (c:Customer), (o:Order)
+        WHERE c.customer_id = $customer AND o.order_id = $order
+        CREATE (c)-[:PLACED]->(o)
+        RETURN c, o
+    """,
+    placeholder={"customer": "abc123", "order": "o-789"},
+)
+
+graph.delete_relationship(
+    query="""
+        MATCH (c:Customer)-[r:PLACED]->(o:Order)
+        WHERE c.customer_id = $customer AND o.order_id = $order
+        DETACH DELETE r
+    """,
+    placeholder={"customer": "abc123", "order": "o-789"},
+)
+```
+
+Validation ensures relationship queries include edge notation and destructive operations actually delete nodes/relationships.
+
+### SNS Event Publishing
+
+```python
+graph = adapter(
+    bolt={...},
+    sns_arn="arn:aws:sns:us-east-2:123456789012:customers",
+    sns_attributes={"service": "crm"},
+)
+
+graph.delete(delete_identifier="abc123", node="Customer", identifier="customer_id")
+```
+
+Each write publishes an event with merged attributes (`operation`, default adapter attributes, custom attributes, and call-specific overrides).
+
+## 🧪 Testing
+
+We split fast unit tests from integration suites targeting Neo4j and Neptune-compatible endpoints.
+
+```bash
+# Unit tests (pure Python, heavy mocking)
+pipenv run test
+
+# Integration suites
+pipenv run test_neo4j     # requires Neo4j Bolt endpoint (defaults to bolt://localhost:7687)
+pipenv run test_neptune   # reuses Bolt settings, can point at Neptune or LocalStack
+
+# Coverage (Neo4j suite under coverage)
+pipenv run coverage
+```
+
+Environment variables to override defaults:
+
+| Variable               | Purpose                            | Default               |
+| ---------------------- | ---------------------------------- | --------------------- |
+| `NEO4J_BOLT_URL`       | Neo4j Bolt connection URI          | `bolt://localhost:7687` |
+| `NEO4J_USER` / `_PASSWORD` | Neo4j credentials                | `neo4j` / `password`  |
+| `NEPTUNE_BOLT_URL`     | Neptune Bolt-compatible endpoint   | falls back to Neo4j   |
+| `NEPTUNE_USER` / `_PASSWORD` | Neptune credentials             | falls back to Neo4j   |
+
+## 🧰 Tooling & CI
+
+`.circleci/config.yml` mirrors the DynamoDB project:
+
+- `install-build` installs dependencies and persists the workspace.
+- `lint` and `type-check` run `pipenv run lint` and `pipenv run mypy`.
+- `test-neo4j` and `test-neptune` run pytest markers in parallel; the Neptune job provisions a LocalStack container for compatibility checks.
+- `install-build-publish` retains the token-based PyPI workflow.
+
+## 🛠️ Local Development
+
+### Prerequisites
+
+- Python **3.9+**
+- [Pipenv](https://pipenv.pypa.io/)
+- Docker (for running Neo4j or LocalStack locally)
+
+### Environment Setup
+
+```bash
+git clone https://github.com/paulcruse3/daplug-cypher.git
+cd daplug-cypher
+pipenv install --dev
+```
+
+### Workflow
+
+```bash
+pipenv run lint          # pylint (JSON + HTML report)
+pipenv run mypy          # static typing (post-phase polish)
+pipenv run test          # unit tests
+pipenv run test_neo4j    # integration suite (requires Bolt endpoint)
+pipenv run test_neptune  # integration suite (LocalStack/Neptune)
+```
+
+When running Neo4j via Docker, set `NEO4J_AUTH=neo4j/password` before `docker run` so the tests can authenticate automatically.
+
+## 🗂️ Project Structure
+
+```txt
+daplug-cypher/
+├── daplug_cypher/
+│   ├── adapter.py         # Cypher adapter implementation
+│   ├── common/            # Shared schema, merge, logging, publisher helpers
+│   ├── cypher/            # Parameter + serialization utilities
+│   ├── types/             # Shared TypedDict/type aliases (reused by common)
+│   └── __init__.py        # Public adapter factory & exports
+├── tests/
+│   ├── integration/       # Neo4j & Neptune pytest suites
+│   └── unit/              # Mock-based unit coverage for every module
+├── .circleci/config.yml   # CI pipeline
+├── Pipfile                # Runtime & dev dependencies + scripts
+├── setup.py / setup.cfg   # Packaging metadata & pytest config
+└── README.md              # You are here
+```
+
+## 🤝 Contributing
+
+We welcome issues and pull requests! Please ensure linting, typing, and both integration suites pass before submitting.
+
+```bash
+git checkout -b feature/amazing-cypher
+# make your changes
+pipenv run lint
+pipenv run mypy
+pipenv run test
+pipenv run test_neo4j
+pipenv run test_neptune
+git commit -am "feat: amazing cypher enhancement"
+git push origin feature/amazing-cypher
+```
+
+## 📄 License
+
+Apache License 2.0 – see [LICENSE](LICENSE) for the full text.
+
+---
+
+> Built to keep Cypher integrations as clean and predictable