cjm-graph-plugin-sqlite 0.0.2__tar.gz

cjm_graph_plugin_sqlite-0.0.2/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 2022, fastai
+
+   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.

cjm_graph_plugin_sqlite-0.0.2/MANIFEST.in

@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

cjm_graph_plugin_sqlite-0.0.2/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.4
+Name: cjm-graph-plugin-sqlite
+Version: 0.0.2
+Summary: A local, file-backed Context Graph worker for the cjm-plugin-system that implements graph storage, traversal, and querying using SQLite.
+Home-page: https://github.com/cj-mills/cjm-graph-plugin-sqlite
+Author: Christian J. Mills
+Author-email: 9126128+cj-mills@users.noreply.github.com
+License: Apache Software License 2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cjm_graph_plugin_system
+Provides-Extra: dev
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# cjm-graph-plugin-sqlite
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install
+
+``` bash
+pip install cjm_graph_plugin_sqlite
+```
+
+## Project Structure
+
+    nbs/
+    ├── meta.ipynb   # Metadata introspection for the SQLite Graph plugin used by cjm-ctl to generate the registration manifest.
+    └── plugin.ipynb # Plugin implementation for Context Graph using SQLite
+
+Total: 2 notebooks
+
+## Module Dependencies
+
+``` mermaid
+graph LR
+    meta[meta<br/>Metadata]
+    plugin[plugin<br/>SQLite Graph Plugin]
+
+    plugin --> meta
+```
+
+*1 cross-module dependencies detected*
+
+## CLI Reference
+
+No CLI commands found in this project.
+
+## Module Overview
+
+Detailed documentation for each module in the project:
+
+### Metadata (`meta.ipynb`)
+
+> Metadata introspection for the SQLite Graph plugin used by cjm-ctl to
+> generate the registration manifest.
+
+#### Import
+
+``` python
+from cjm_graph_plugin_sqlite.meta import (
+    get_plugin_metadata
+)
+```
+
+#### Functions
+
+``` python
+def get_plugin_metadata() -> Dict[str, Any]:  # Plugin metadata for manifest generation
+    """Return metadata required to register this plugin with the PluginManager."""
+    # Fallback base path (current behavior for backward compatibility)
+    base_path = os.path.dirname(os.path.dirname(sys.executable))
+    
+    # Use CJM config if available, else fallback to env-relative paths
+    cjm_data_dir = os.environ.get("CJM_DATA_DIR")
+    
+    # Plugin data directory
+    plugin_name = "cjm-graph-plugin-sqlite"
+    if cjm_data_dir
+    "Return metadata required to register this plugin with the PluginManager."
+```
+
+### SQLite Graph Plugin (`plugin.ipynb`)
+
+> Plugin implementation for Context Graph using SQLite
+
+#### Import
+
+``` python
+from cjm_graph_plugin_sqlite.plugin import (
+    SQLiteGraphPluginConfig,
+    SQLiteGraphPlugin
+)
+```
+
+#### Classes
+
+``` python
+@dataclass
+class SQLiteGraphPluginConfig:
+    "Configuration for SQLite Graph Plugin."
+    
+    db_path: Optional[str] = field(...)
+    readonly: bool = field(...)
+```
+
+``` python
+class SQLiteGraphPlugin:
+    def __init__(self):
+        self.logger = logging.getLogger(f"{__name__}.{type(self).__name__}")
+        self.config: SQLiteGraphPluginConfig = None
+    "Local, file-backed Context Graph implementation using SQLite."
+    
+    def __init__(self):
+            self.logger = logging.getLogger(f"{__name__}.{type(self).__name__}")
+            self.config: SQLiteGraphPluginConfig = None
+    
+    def name(self) -> str:  # Plugin name identifier
+            """Get the plugin name identifier."""
+            return "sqlite_graph"
+    
+        @property
+        def version(self) -> str:  # Plugin version string
+        "Get the plugin name identifier."
+    
+    def version(self) -> str:  # Plugin version string
+            """Get the plugin version string."""
+            return "0.1.0"
+    
+        def get_current_config(self) -> Dict[str, Any]:  # Current configuration as dictionary
+        "Get the plugin version string."
+    
+    def get_current_config(self) -> Dict[str, Any]:  # Current configuration as dictionary
+            """Return current configuration state."""
+            if not self.config
+        "Return current configuration state."
+    
+    def get_config_schema(self) -> Dict[str, Any]:  # JSON Schema for configuration
+            """Return JSON Schema for UI generation."""
+            return dataclass_to_jsonschema(SQLiteGraphPluginConfig)
+    
+        def initialize(
+            self,
+            config: Optional[Any] = None  # Configuration dataclass, dict, or None
+        ) -> None
+        "Return JSON Schema for UI generation."
+    
+    def initialize(
+            self,
+            config: Optional[Any] = None  # Configuration dataclass, dict, or None
+        ) -> None
+        "Initialize DB connection and schema."
+    
+    def execute(
+            self,
+            action: str = "get_schema",  # Action to perform
+            **kwargs
+        ) -> Dict[str, Any]:  # JSON-serializable result
+        "Dispatch to appropriate method based on action."
+    
+    def add_nodes(
+            self,
+            nodes: List[GraphNode]  # Nodes to create
+        ) -> List[str]:  # Created node IDs
+        "Bulk create nodes."
+    
+    def add_edges(
+            self,
+            edges: List[GraphEdge]  # Edges to create
+        ) -> List[str]:  # Created edge IDs
+        "Bulk create edges."
+    
+    def get_node(
+            self,
+            node_id: str  # UUID of node to retrieve
+        ) -> Optional[GraphNode]:  # Node or None if not found
+        "Get a single node by ID."
+    
+    def get_edge(
+            self,
+            edge_id: str  # UUID of edge to retrieve
+        ) -> Optional[GraphEdge]:  # Edge or None if not found
+        "Get a single edge by ID."
+    
+    def find_nodes_by_source(
+            self,
+            source_ref: SourceRef  # External resource reference
+        ) -> List[GraphNode]:  # Nodes attached to this source
+        "Find all nodes linked to a specific external resource."
+    
+    def find_nodes_by_label(
+            self,
+            label: str,  # Node label to search for
+            limit: int = 100  # Max results
+        ) -> List[GraphNode]:  # Matching nodes
+        "Find nodes by label."
+    
+    def get_context(
+            self,
+            node_id: str,  # Starting node UUID
+            depth: int = 1,  # Traversal depth (1 = immediate neighbors)
+            filter_labels: Optional[List[str]] = None  # Only include nodes with these labels
+        ) -> GraphContext:  # Subgraph containing node and its neighborhood
+        "Get the neighborhood of a specific node."
+    
+    def update_node(
+            self,
+            node_id: str,  # UUID of node to update
+            properties: Dict[str, Any]  # Properties to merge/update
+        ) -> bool:  # True if successful
+        "Partial update of node properties."
+    
+    def update_edge(
+            self,
+            edge_id: str,  # UUID of edge to update
+            properties: Dict[str, Any]  # Properties to merge/update
+        ) -> bool:  # True if successful
+        "Partial update of edge properties."
+    
+    def delete_nodes(
+            self,
+            node_ids: List[str],  # UUIDs of nodes to delete
+            cascade: bool = True  # Also delete connected edges
+        ) -> int:  # Number of nodes deleted
+        "Delete nodes (and optionally connected edges)."
+    
+    def delete_edges(
+            self,
+            edge_ids: List[str]  # UUIDs of edges to delete
+        ) -> int:  # Number of edges deleted
+        "Delete edges."
+    
+    def get_schema(self) -> Dict[str, Any]:  # Graph schema/ontology
+            """Return the current ontology/schema of the graph."""
+            schema = {"node_labels": [], "edge_types": [], "counts": {}}
+        "Return the current ontology/schema of the graph."
+    
+    def import_graph(
+            self,
+            graph_data: GraphContext,  # Data to import
+            merge_strategy: str = "overwrite"  # "overwrite", "skip", or "merge"
+        ) -> Dict[str, int]:  # Import statistics {nodes_created, edges_created, ...}
+        "Bulk import a GraphContext (e.g., from backup or another plugin)."
+    
+    def export_graph(
+            self,
+            filter_query: Optional[GraphQuery] = None  # Optional filter
+        ) -> GraphContext:  # Exported subgraph or full graph
+        "Export the entire graph or a filtered subset."
+    
+    def cleanup(self) -> None
+        "Clean up resources."
+```