cypher-guardrail 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. cypher_guardrail-1.0.0/LICENSE +202 -0
  2. cypher_guardrail-1.0.0/PKG-INFO +147 -0
  3. cypher_guardrail-1.0.0/README.md +123 -0
  4. cypher_guardrail-1.0.0/pyproject.toml +77 -0
  5. cypher_guardrail-1.0.0/pyproject.toml.orig +63 -0
  6. cypher_guardrail-1.0.0/src/cypher_guardrail/__init__.py +37 -0
  7. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/__init__.py +0 -0
  8. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/core/__init__.py +0 -0
  9. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/core/builders.py +209 -0
  10. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/core/errors.py +77 -0
  11. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/core/io.py +402 -0
  12. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/core/literals.py +313 -0
  13. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/core/queries.py +294 -0
  14. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/core/scopes.py +407 -0
  15. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/core/valuetypes.py +19 -0
  16. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/sources/__init__.py +0 -0
  17. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/sources/capture.py +302 -0
  18. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/sources/hybrid.py +266 -0
  19. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/sources/offline.py +549 -0
  20. cypher_guardrail-1.0.0/src/cypher_guardrail/_internal/sources/online.py +286 -0
  21. cypher_guardrail-1.0.0/src/cypher_guardrail/backend.py +431 -0
  22. cypher_guardrail-1.0.0/src/cypher_guardrail/issues.py +215 -0
  23. cypher_guardrail-1.0.0/src/cypher_guardrail/live.py +602 -0
  24. cypher_guardrail-1.0.0/src/cypher_guardrail/patterns.py +475 -0
  25. cypher_guardrail-1.0.0/src/cypher_guardrail/py.typed +0 -0
  26. cypher_guardrail-1.0.0/src/cypher_guardrail/snapshot.py +599 -0
  27. cypher_guardrail-1.0.0/src/cypher_guardrail/utils.py +178 -0
  28. cypher_guardrail-1.0.0/src/cypher_guardrail/validators/__init__.py +0 -0
  29. cypher_guardrail-1.0.0/src/cypher_guardrail/validators/properties_validator.py +913 -0
  30. cypher_guardrail-1.0.0/src/cypher_guardrail/validators/schema_validator.py +750 -0
  31. cypher_guardrail-1.0.0/src/cypher_guardrail/validators/syntax_validator.py +282 -0
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 Killeroid
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,147 @@
1
+ Metadata-Version: 2.4
2
+ Name: cypher-guardrail
3
+ Version: 1.0.0
4
+ Summary: Parse and validate cypher queries against a given FalkorDB Knowledge Graph schema. Validates query syntax, schema validity, and property access.
5
+ Keywords: cypher,FalkorDB,validation,parser,graph,database,graphdb,opencypher
6
+ Author: Killeroid
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
13
+ Requires-Dist: regex>=2024.11.6
14
+ Requires-Dist: pandas>=2.2.3
15
+ Requires-Dist: falkordb>=1.8.0
16
+ Requires-Dist: redis>=8.0.0,<9
17
+ Requires-Python: >=3.11
18
+ Project-URL: Homepage, https://github.com/Killeroid/cypher-guardrail
19
+ Project-URL: Documentation, https://cypher-guardrail.readthedocs.io/en/latest/
20
+ Project-URL: Changelog, https://github.com/Killeroid/cypher-guardrail/blob/main/CHANGELOG.md
21
+ Project-URL: Issues, https://github.com/Killeroid/cypher-guardrail/issues
22
+ Project-URL: Repository, https://github.com/Killeroid/cypher-guardrail
23
+ Description-Content-Type: text/markdown
24
+
25
+ # cypher-guardrail
26
+
27
+ **Syntax, schema and property-access validation of Cypher queries against a [FalkorDB](https://www.falkordb.com/) graph.**
28
+
29
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Killeroid/cypher-guardrail/blob/main/LICENSE)
30
+ [![Python](https://img.shields.io/badge/Python-%3E%3D3.11-brightgreen)](https://www.python.org/)
31
+ [![Documentation](https://app.readthedocs.org/projects/cypher-guardrail/badge/?version=latest)](https://cypher-guardrail.readthedocs.io/en/latest/)
32
+
33
+ cypher-guardrail checks and validates a Cypher query before it runs, which is useful for queries written by a person or generated by an LLM. It never executes your query or changes your data.
34
+
35
+ * **Syntax**: is the query valid, does it write to the graph, are its `$parameters` provided, do its variables carry conflicting labels?
36
+ * **Schema**: do the labels, relationship types, paths (and their direction) and full-text or vector indexes it uses exist in the graph?
37
+ * **Properties**: does each property it reads exist on the label it is read from?
38
+ * **Structured results**: every validator returns a score or a verdict plus metadata that says what is wrong, without parsing text.
39
+ * **Sync and async**, and **offline**: validate against a saved snapshot of the schema when no database is at hand.
40
+
41
+ ## Installation
42
+
43
+ Python 3.11 or later.
44
+
45
+ ```sh
46
+ pip install cypher-guardrail
47
+ ```
48
+
49
+ or, with uv:
50
+
51
+ ```sh
52
+ uv add cypher-guardrail
53
+ ```
54
+
55
+ ## Quickstart
56
+
57
+ ```python
58
+ from falkordb import FalkorDB
59
+ from cypher_guardrail import PropertiesValidator, SchemaValidator, SyntaxValidator
60
+
61
+ driver = FalkorDB(host="localhost", port=6379)
62
+ graph = "my_graph"
63
+ query = "MATCH (g:Goal)-[:HAS_TARGET]->(t:Target) WHERE g.code = '1' RETURN t"
64
+
65
+ is_valid, syntax_metadata = SyntaxValidator(driver).validate(query, database_name=graph)
66
+ schema_score, schema_metadata = SchemaValidator(driver).validate(
67
+ query, database_name=graph
68
+ )
69
+ props_score, props_metadata = PropertiesValidator(driver).validate(
70
+ query, database_name=graph
71
+ )
72
+
73
+ kg_valid = is_valid and schema_score == 1 and props_score in (1, None)
74
+ ```
75
+
76
+ Always check the syntax first: a syntax error makes the other two results misleading.
77
+
78
+ ## How the results are computed
79
+
80
+ ### Syntax: `is_valid`
81
+
82
+ `True` if FalkorDB accepts the query, it is read-only (`read_only=True` is the default), and none of its `$parameters` is missing. `False` otherwise.
83
+
84
+ ### Schema score
85
+
86
+ A number from 0 to 1. The query's nodes, relationships and paths are each given a share:
87
+
88
+ ```
89
+ node share = labels in the query that exist in the graph / labels in the query
90
+ relationship share = relationship types that exist / relationship types in the query
91
+ path share = paths that exist, in that direction / paths in the query
92
+
93
+ schema score = average of the shares that apply
94
+ ```
95
+
96
+ * Only the kinds the query has take part, and they weigh the same: 1/3 each if it has nodes, relationships and paths, 1/2 each for two kinds, and the share itself for one.
97
+ * A query with none of the three (`MATCH (n) RETURN n`) scores 1.
98
+ * If the query calls a full-text or vector index procedure (`db.idx.fulltext.query...`, `db.idx.vector.query...`):
99
+
100
+ ```
101
+ index share = calls whose index exists / index calls
102
+ schema score = (score above + index share) / 2
103
+ ```
104
+
105
+ ### Properties score
106
+
107
+ ```
108
+ properties score = properties that exist on their label / properties the query accesses
109
+ ```
110
+
111
+ It is `None` when the query accesses no property. Both a property that its label does not have and a property that exists nowhere in the graph count as incorrect. A type-mismatch warning (`check_types=True`) never changes the score.
112
+
113
+ ### KG Valid Query
114
+
115
+ A query is valid against the graph only if all three checks pass:
116
+
117
+ ```
118
+ KG Valid Query = 1 if SyntaxValidator is_valid is True
119
+ and schema score = 1
120
+ and properties score is 1 or None
121
+ 0 otherwise
122
+ ```
123
+
124
+ ## Documentation
125
+
126
+ * [Using the validators](https://cypher-guardrail.readthedocs.io/en/latest/usage.html): connecting, read-only mode, parameters, `UNION`, type checks
127
+ * [Reading the metadata](https://cypher-guardrail.readthedocs.io/en/latest/metadata.html): every issue code and its fields
128
+ * [Snapshots](https://cypher-guardrail.readthedocs.io/en/latest/snapshots.html): offline and hybrid validation, and keeping a snapshot fresh
129
+ * [Async usage](https://cypher-guardrail.readthedocs.io/en/latest/async.html)
130
+ * [Runnable examples](https://github.com/Killeroid/cypher-guardrail/tree/main/examples): a quickstart, offline validation with a snapshot, and async validation (no server needed)
131
+ * [CHANGELOG](https://cypher-guardrail.readthedocs.io/en/latest/changelog.html)
132
+
133
+ ## Development
134
+
135
+ ```sh
136
+ uv sync # create the environment (Python >= 3.12 also installs FalkorDBLite for the tests)
137
+ uv run pytest # run the tests
138
+ uv run --group docs sphinx-build -W docs docs/_build/html # build the documentation
139
+ ```
140
+
141
+ [`.github/workflows/publish.yml`](https://github.com/Killeroid/cypher-guardrail/blob/main/.github/workflows/publish.yml) publishes a release to PyPI when a version tag is pushed: set `version` in `pyproject.toml`, add the release to `CHANGELOG.md`, then `git tag vX.Y.Z && git push origin vX.Y.Z`.
142
+
143
+ Contributions are welcome: please open an issue or a pull request.
144
+
145
+ ## License
146
+
147
+ [Apache License 2.0](https://github.com/Killeroid/cypher-guardrail/blob/main/LICENSE)
@@ -0,0 +1,123 @@
1
+ # cypher-guardrail
2
+
3
+ **Syntax, schema and property-access validation of Cypher queries against a [FalkorDB](https://www.falkordb.com/) graph.**
4
+
5
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Killeroid/cypher-guardrail/blob/main/LICENSE)
6
+ [![Python](https://img.shields.io/badge/Python-%3E%3D3.11-brightgreen)](https://www.python.org/)
7
+ [![Documentation](https://app.readthedocs.org/projects/cypher-guardrail/badge/?version=latest)](https://cypher-guardrail.readthedocs.io/en/latest/)
8
+
9
+ cypher-guardrail checks and validates a Cypher query before it runs, which is useful for queries written by a person or generated by an LLM. It never executes your query or changes your data.
10
+
11
+ * **Syntax**: is the query valid, does it write to the graph, are its `$parameters` provided, do its variables carry conflicting labels?
12
+ * **Schema**: do the labels, relationship types, paths (and their direction) and full-text or vector indexes it uses exist in the graph?
13
+ * **Properties**: does each property it reads exist on the label it is read from?
14
+ * **Structured results**: every validator returns a score or a verdict plus metadata that says what is wrong, without parsing text.
15
+ * **Sync and async**, and **offline**: validate against a saved snapshot of the schema when no database is at hand.
16
+
17
+ ## Installation
18
+
19
+ Python 3.11 or later.
20
+
21
+ ```sh
22
+ pip install cypher-guardrail
23
+ ```
24
+
25
+ or, with uv:
26
+
27
+ ```sh
28
+ uv add cypher-guardrail
29
+ ```
30
+
31
+ ## Quickstart
32
+
33
+ ```python
34
+ from falkordb import FalkorDB
35
+ from cypher_guardrail import PropertiesValidator, SchemaValidator, SyntaxValidator
36
+
37
+ driver = FalkorDB(host="localhost", port=6379)
38
+ graph = "my_graph"
39
+ query = "MATCH (g:Goal)-[:HAS_TARGET]->(t:Target) WHERE g.code = '1' RETURN t"
40
+
41
+ is_valid, syntax_metadata = SyntaxValidator(driver).validate(query, database_name=graph)
42
+ schema_score, schema_metadata = SchemaValidator(driver).validate(
43
+ query, database_name=graph
44
+ )
45
+ props_score, props_metadata = PropertiesValidator(driver).validate(
46
+ query, database_name=graph
47
+ )
48
+
49
+ kg_valid = is_valid and schema_score == 1 and props_score in (1, None)
50
+ ```
51
+
52
+ Always check the syntax first: a syntax error makes the other two results misleading.
53
+
54
+ ## How the results are computed
55
+
56
+ ### Syntax: `is_valid`
57
+
58
+ `True` if FalkorDB accepts the query, it is read-only (`read_only=True` is the default), and none of its `$parameters` is missing. `False` otherwise.
59
+
60
+ ### Schema score
61
+
62
+ A number from 0 to 1. The query's nodes, relationships and paths are each given a share:
63
+
64
+ ```
65
+ node share = labels in the query that exist in the graph / labels in the query
66
+ relationship share = relationship types that exist / relationship types in the query
67
+ path share = paths that exist, in that direction / paths in the query
68
+
69
+ schema score = average of the shares that apply
70
+ ```
71
+
72
+ * Only the kinds the query has take part, and they weigh the same: 1/3 each if it has nodes, relationships and paths, 1/2 each for two kinds, and the share itself for one.
73
+ * A query with none of the three (`MATCH (n) RETURN n`) scores 1.
74
+ * If the query calls a full-text or vector index procedure (`db.idx.fulltext.query...`, `db.idx.vector.query...`):
75
+
76
+ ```
77
+ index share = calls whose index exists / index calls
78
+ schema score = (score above + index share) / 2
79
+ ```
80
+
81
+ ### Properties score
82
+
83
+ ```
84
+ properties score = properties that exist on their label / properties the query accesses
85
+ ```
86
+
87
+ It is `None` when the query accesses no property. Both a property that its label does not have and a property that exists nowhere in the graph count as incorrect. A type-mismatch warning (`check_types=True`) never changes the score.
88
+
89
+ ### KG Valid Query
90
+
91
+ A query is valid against the graph only if all three checks pass:
92
+
93
+ ```
94
+ KG Valid Query = 1 if SyntaxValidator is_valid is True
95
+ and schema score = 1
96
+ and properties score is 1 or None
97
+ 0 otherwise
98
+ ```
99
+
100
+ ## Documentation
101
+
102
+ * [Using the validators](https://cypher-guardrail.readthedocs.io/en/latest/usage.html): connecting, read-only mode, parameters, `UNION`, type checks
103
+ * [Reading the metadata](https://cypher-guardrail.readthedocs.io/en/latest/metadata.html): every issue code and its fields
104
+ * [Snapshots](https://cypher-guardrail.readthedocs.io/en/latest/snapshots.html): offline and hybrid validation, and keeping a snapshot fresh
105
+ * [Async usage](https://cypher-guardrail.readthedocs.io/en/latest/async.html)
106
+ * [Runnable examples](https://github.com/Killeroid/cypher-guardrail/tree/main/examples): a quickstart, offline validation with a snapshot, and async validation (no server needed)
107
+ * [CHANGELOG](https://cypher-guardrail.readthedocs.io/en/latest/changelog.html)
108
+
109
+ ## Development
110
+
111
+ ```sh
112
+ uv sync # create the environment (Python >= 3.12 also installs FalkorDBLite for the tests)
113
+ uv run pytest # run the tests
114
+ uv run --group docs sphinx-build -W docs docs/_build/html # build the documentation
115
+ ```
116
+
117
+ [`.github/workflows/publish.yml`](https://github.com/Killeroid/cypher-guardrail/blob/main/.github/workflows/publish.yml) publishes a release to PyPI when a version tag is pushed: set `version` in `pyproject.toml`, add the release to `CHANGELOG.md`, then `git tag vX.Y.Z && git push origin vX.Y.Z`.
118
+
119
+ Contributions are welcome: please open an issue or a pull request.
120
+
121
+ ## License
122
+
123
+ [Apache License 2.0](https://github.com/Killeroid/cypher-guardrail/blob/main/LICENSE)
@@ -0,0 +1,77 @@
1
+ [build-system]
2
+ requires = ["uv_build>=0.13.0,<0.14"]
3
+ build-backend = "uv_build"
4
+
5
+ [project]
6
+ name = "cypher-guardrail"
7
+ version = "1.0.0"
8
+ description = "Parse and validate cypher queries against a given FalkorDB Knowledge Graph schema. Validates query syntax, schema validity, and property access."
9
+ readme = "README.md"
10
+ dependencies = [
11
+ "regex>=2024.11.6",
12
+ "pandas>=2.2.3",
13
+ "falkordb>=1.8.0",
14
+ "redis>=8.0.0,<9",
15
+ ]
16
+ requires-python = ">=3.11"
17
+ keywords = [
18
+ "cypher",
19
+ "FalkorDB",
20
+ "validation",
21
+ "parser",
22
+ "graph",
23
+ "database",
24
+ "graphdb",
25
+ "opencypher",
26
+ ]
27
+ classifiers = [
28
+ "Programming Language :: Python :: 3",
29
+ "Operating System :: OS Independent",
30
+ "Intended Audience :: Developers",
31
+ "Topic :: Software Development :: Libraries :: Python Modules",
32
+ ]
33
+ license = "Apache-2.0"
34
+ license-files = ["LICENSE"]
35
+
36
+ [[project.authors]]
37
+ name = "Killeroid"
38
+
39
+ [project.urls]
40
+ Homepage = "https://github.com/Killeroid/cypher-guardrail"
41
+ Documentation = "https://cypher-guardrail.readthedocs.io/en/latest/"
42
+ Changelog = "https://github.com/Killeroid/cypher-guardrail/blob/main/CHANGELOG.md"
43
+ Issues = "https://github.com/Killeroid/cypher-guardrail/issues"
44
+ Repository = "https://github.com/Killeroid/cypher-guardrail"
45
+
46
+ [tool.uv.build-backend]
47
+ module-name = "cypher_guardrail"
48
+
49
+ [tool.pytest.ini_options]
50
+ testpaths = ["tests"]
51
+
52
+ [tool.ruff]
53
+ src = ["src"]
54
+
55
+ [tool.ruff.lint]
56
+ extend-select = [
57
+ "B",
58
+ "I",
59
+ "UP",
60
+ ]
61
+
62
+ [tool.ty.environment]
63
+ python = ".venv"
64
+
65
+ [dependency-groups]
66
+ dev = [
67
+ "falkordblite; python_version >= '3.12'",
68
+ "pytest>=9.1.1",
69
+ "ruff>=0.17.0",
70
+ "ty>=0.0.87",
71
+ ]
72
+ docs = [
73
+ "furo>=2025.12.19",
74
+ "myst-parser>=5.1.0",
75
+ "sphinx>=9.0.4",
76
+ "sphinx-copybutton>=0.5.2",
77
+ ]
@@ -0,0 +1,63 @@
1
+ [build-system]
2
+ requires = ["uv_build>=0.13.0,<0.14"]
3
+ build-backend = "uv_build"
4
+
5
+ [project]
6
+ name = "cypher-guardrail"
7
+ version = "1.0.0"
8
+ description = "Parse and validate cypher queries against a given FalkorDB Knowledge Graph schema. Validates query syntax, schema validity, and property access."
9
+ readme = "README.md"
10
+ authors = [{ name = "Killeroid" }]
11
+ dependencies = [
12
+ "regex>=2024.11.6",
13
+ "pandas>=2.2.3",
14
+ "falkordb>=1.8.0",
15
+ "redis>=8.0.0,<9",
16
+ ]
17
+ requires-python = ">=3.11"
18
+ keywords = ["cypher", "FalkorDB", "validation", "parser", "graph", "database", "graphdb", "opencypher"]
19
+ classifiers=[
20
+ 'Programming Language :: Python :: 3',
21
+ 'Operating System :: OS Independent',
22
+ 'Intended Audience :: Developers',
23
+ 'Topic :: Software Development :: Libraries :: Python Modules',
24
+ ]
25
+ license = "Apache-2.0"
26
+ license-files = ["LICENSE"]
27
+
28
+
29
+ [tool.uv.build-backend]
30
+ module-name = "cypher_guardrail"
31
+
32
+ [dependency-groups]
33
+ dev = [
34
+ "falkordblite; python_version >= '3.12'",
35
+ "pytest>=9.1.1",
36
+ "ruff>=0.17.0",
37
+ "ty>=0.0.87",
38
+ ]
39
+ docs = [
40
+ "furo>=2025.12.19",
41
+ "myst-parser>=5.1.0",
42
+ "sphinx>=9.0.4",
43
+ "sphinx-copybutton>=0.5.2",
44
+ ]
45
+
46
+ [tool.pytest.ini_options]
47
+ testpaths = ["tests"]
48
+
49
+ [tool.ruff]
50
+ src = ["src"]
51
+
52
+ [tool.ruff.lint]
53
+ extend-select = ["B", "I", "UP"]
54
+
55
+ [tool.ty.environment]
56
+ python = ".venv"
57
+
58
+ [project.urls]
59
+ Homepage = "https://github.com/Killeroid/cypher-guardrail"
60
+ Documentation = "https://cypher-guardrail.readthedocs.io/en/latest/"
61
+ Changelog = "https://github.com/Killeroid/cypher-guardrail/blob/main/CHANGELOG.md"
62
+ Issues = "https://github.com/Killeroid/cypher-guardrail/issues"
63
+ Repository = "https://github.com/Killeroid/cypher-guardrail"
@@ -0,0 +1,37 @@
1
+ from importlib.metadata import PackageNotFoundError, version
2
+
3
+ try:
4
+ # The distribution name: it must match `name` in pyproject.toml
5
+ __version__ = version("cypher-guardrail")
6
+ except PackageNotFoundError:
7
+ __version__ = "unknown"
8
+
9
+ from cypher_guardrail.live import AsyncLiveSnapshot, LiveSnapshot, StaleSnapshotError
10
+ from cypher_guardrail.snapshot import Snapshot, SnapshotSource
11
+ from cypher_guardrail.validators.properties_validator import (
12
+ AsyncPropertiesValidator,
13
+ PropertiesValidator,
14
+ )
15
+ from cypher_guardrail.validators.schema_validator import (
16
+ AsyncSchemaValidator,
17
+ SchemaValidator,
18
+ )
19
+ from cypher_guardrail.validators.syntax_validator import (
20
+ AsyncSyntaxValidator,
21
+ SyntaxValidator,
22
+ )
23
+
24
+ __all__ = [
25
+ "AsyncLiveSnapshot",
26
+ "AsyncPropertiesValidator",
27
+ "AsyncSchemaValidator",
28
+ "AsyncSyntaxValidator",
29
+ "LiveSnapshot",
30
+ "PropertiesValidator",
31
+ "SchemaValidator",
32
+ "Snapshot",
33
+ "SnapshotSource",
34
+ "StaleSnapshotError",
35
+ "SyntaxValidator",
36
+ "__version__",
37
+ ]