zypherdb 0.1.0__tar.gz

zypherdb-0.1.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0 — 2026-10-28
+
+The first release.
+
+### Added
+
+- **openCypher**: reading and writing clauses, variable-length and shortest paths, subqueries,
+  aggregation, temporal types and functions, `LOAD CSV`, `EXPLAIN` and `PROFILE`; the whole
+  openCypher TCK's positive scenarios pass (see `tests/tck/REPORT.md`).
+- **Indexes and constraints with Neo4j's syntax**: `CREATE INDEX` on node and relationship
+  properties (a field of a document property too), read by equality and range predicates;
+  `CREATE CONSTRAINT ... REQUIRE ... IS UNIQUE`; `SHOW INDEXES`, `SHOW CONSTRAINTS` and `DROP`.
+- **Full-text search** with Neo4j's syntax: English and Spanish analyzers (Snowball stemmers), BM25
+  scores.
+- **Storage** on LMDB (the default) or libmdbx, chosen at build time: transactions, crash safety,
+  readers that never wait, several processes on one database. Storage format 1.
+- **Time zones** from the IANA database, embedded: no system time-zone data needed.
+- **Prepared statements** and a cache of the statements `query` prepares.
+- **Embeddings**: a C ABI (`include/zypherdb.h`) and a Python package (`import zypherdb`). Wheels
+  for Python 3.10 and later (one abi3 wheel per platform) on Linux x86_64 and aarch64
+  (manylinux2014), macOS arm64 and x86_64, and Windows x86_64.
+- **An integrity checker** (`check()`), and the test machinery behind it: storage, query, fault and
+  crash fuzzers, snapshot tests and pair assertions (see `docs/guide/testing.md`).

zypherdb-0.1.0/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 2026 Alberto Casado
+
+   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.

zypherdb-0.1.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: zypherdb
+Version: 0.1.0
+Summary: Python bindings for ZypherDB, an embedded graph database (openCypher on LMDB or libmdbx)
+Requires-Python: >=3.10
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+License-File: vendor/lmdb/LICENSE
+License-File: vendor/lmdb/COPYRIGHT
+License-File: vendor/tzdata/LICENSE
+License-File: vendor/tzdata/LICENSE_APACHE
+Author: Alberto Casado
+Keywords: graph database,graph-database,embedded database,embedded-database,opencypher,cypher,lmdb,libmdbx,zig,full-text search,access control
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Zig
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Project-URL: Homepage, https://github.com/acasadom/zypherdb
+Project-URL: Repository, https://github.com/acasadom/zypherdb
+Project-URL: Documentation, https://acasadom.github.io/zypherdb/
+Project-URL: Issues, https://github.com/acasadom/zypherdb/issues
+Project-URL: Changelog, https://github.com/acasadom/zypherdb/blob/main/CHANGELOG.md
+Requires-Dist: tzdata; sys_platform == 'win32'
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Description-Content-Type: text/markdown
+
+# ZypherDB
+
+*An embedded graph database that speaks openCypher.*
+
+[![CI](https://github.com/acasadom/zypherdb/actions/workflows/ci.yml/badge.svg)](https://github.com/acasadom/zypherdb/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/acasadom/zypherdb/blob/main/LICENSE)
+![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+[![Docs](https://img.shields.io/badge/docs-acasadom.github.io%2Fzypherdb-blue)](https://acasadom.github.io/zypherdb/)
+
+ZypherDB is to graphs what SQLite is to tables: a database that lives inside your process and
+keeps its data in a directory, with no server to run. You store nodes and relationships and
+query them in **openCypher**, the language of Neo4j. Several processes can share a database, and
+a crash never leaves it half-written. The engine is written in Zig, on LMDB.
+
+## Install
+
+```bash
+pip install zypherdb
+```
+
+Python 3.10 or later, on Linux (x86_64, aarch64), macOS (Apple silicon, Intel) and Windows
+(x86_64). No dependencies (on Windows, only `tzdata`).
+
+## A first look
+
+Who may open a door, through groups nested to any depth, and at what times:
+
+```python
+from zypherdb import Database
+
+db = Database("lab.db")  # a directory, created if missing
+
+db.query("CREATE INDEX FOR (d:Door) ON (d.name)")  # doors are looked up by name
+db.query("""
+    CREATE (ana:Person {name: 'Ana'}), (bo:Person {name: 'Bo'}),
+           (staff:Group {name: 'Lab staff'}), (bsl3:Group {name: 'BSL-3'}),
+           (airlock:Door {name: 'BSL-3 airlock'})
+    CREATE (ana)-[:MEMBER_OF]->(bsl3)-[:PART_OF]->(staff),
+           (bo)-[:MEMBER_OF]->(staff),
+           (bsl3)-[:MAY_OPEN {from: localtime('07:00'), until: localtime('19:00')}]->(airlock)
+""")
+
+rows = db.query("""
+    MATCH (:Door {name: $door})<-[rule:MAY_OPEN]-(:Group)<-[:PART_OF*0..]-(:Group)<-[:MEMBER_OF]-(p:Person)
+    RETURN p.name, rule.from, rule.until
+""", door="BSL-3 airlock")
+print(rows)  # [['Ana', datetime.time(7, 0), datetime.time(19, 0)]]
+```
+
+Results come back as Python values: numbers, strings, lists, dicts, `datetime` types with their
+time zones, and nodes, relationships and paths.
+
+Full-text search, with stemming and BM25 ranking, in Neo4j's syntax:
+
+```python
+db.query("CREATE (:Protocol {title: 'Airlock', body: 'Spray the doors before opening them'})")
+db.query("""
+    CREATE FULLTEXT INDEX protocols FOR (p:Protocol) ON EACH [p.title, p.body]
+    OPTIONS {indexConfig: {`fulltext.analyzer`: 'english'}}
+""")
+print(db.query("""
+    CALL db.index.fulltext.queryNodes('protocols', 'door AND open') YIELD node, score
+    RETURN node.title, score
+"""))  # [['Airlock', 0.5753641449035617]]
+```
+
+And a look at how a query runs: `explain` returns its plan, and `profile` runs it and counts the
+rows each step made:
+
+```python
+def show(plan, depth=0):
+    print("  " * depth + f"{plan['operator']} {plan['details']}   rows: {plan['rows']}")
+    for child in plan["children"]:
+        show(child, depth + 1)
+
+rows, plan = db.profile("""
+    MATCH (:Door {name: $door})<-[rule:MAY_OPEN]-(:Group)<-[:PART_OF*0..]-(:Group)<-[:MEMBER_OF]-(p:Person)
+    RETURN p.name, rule.from, rule.until
+""", door="BSL-3 airlock")
+show(plan)
+```
+
+```text
+Return p.name, rule.from, rule.until   rows: 1
+  Expand(All) (:Group)<-[:MEMBER_OF]-(p:Person)   rows: 1
+    VarLengthExpand(All) (:Group)<-[:PART_OF*0..]-(:Group)   rows: 1
+      Expand(All) (:Door {name: $door})<-[rule:MAY_OPEN]-(:Group)   rows: 1
+        NodeIndexSeek (:Door {name: $door})   rows: 1
+```
+
+The [tutorial](https://acasadom.github.io/zypherdb/tutorial/01-getting-started.html) goes from
+here to a complete access-control system in twenty short steps.
+
+## What it can do
+
+- **openCypher**: `MATCH` and `OPTIONAL MATCH`, variable-length and shortest paths, `WITH`,
+  `UNWIND`, `UNION`, subqueries, `EXISTS { }` and `COUNT { }`; `CREATE`, `MERGE`, `SET`,
+  `REMOVE`, `DELETE`, `FOREACH`; `LOAD CSV`; every aggregate; string, list, math, temporal and
+  graph functions.
+- **Values**: integers, floats, strings, booleans, lists, maps, and the six temporal types with
+  time zones. Properties can also hold maps, so a node can carry a document.
+- **Indexes**: property indexes for equality and ranges, on node labels and relationship types,
+  and on fields inside documents; full-text indexes in English and Spanish; uniqueness constraints.
+- **Storage**: transactions, crash safety, three durability levels, one writer and any number of
+  readers across processes (readers never wait), and an integrity checker.
+- **Queries**: plans of operators with index seeks, `EXPLAIN` and `PROFILE`, prepared statements
+  and a statement cache.
+
+ZypherDB passes all 3202 scenarios of the [openCypher TCK](https://github.com/acasadom/zypherdb/blob/main/tests/tck/README.md)
+that expect a result, and all 694 that expect an error. The
+[Cypher reference](https://acasadom.github.io/zypherdb/guide/cypher.html) lists what it does not
+support yet. Python is the first language binding; C, C++ and JavaScript come next.
+
+## Documentation
+
+[acasadom.github.io/zypherdb](https://acasadom.github.io/zypherdb/) has the tutorial, the
+[Cypher](https://acasadom.github.io/zypherdb/guide/cypher.html) and
+[Python](https://acasadom.github.io/zypherdb/guide/python.html) references, and how it works
+inside: the [architecture](https://acasadom.github.io/zypherdb/guide/architecture.html), the
+storage layout, the query planner, [performance](https://acasadom.github.io/zypherdb/guide/performance.html)
+and [testing](https://acasadom.github.io/zypherdb/guide/testing.html) (fuzzers, crash and fault
+injection, the TCK).
+
+## Building from source
+
+You need [Zig 0.17](https://ziglang.org/download/): `zig build test` runs the tests and
+`pip install .` builds the Python package. The
+[contributing guide](https://acasadom.github.io/zypherdb/guide/contributing.html) has the rest.
+
+## License
+
+Apache License 2.0. ZypherDB includes LMDB, libmdbx, the IANA time-zone database, and data and
+algorithms from Unicode and Snowball, under their own licenses: see
+[THIRD_PARTY_NOTICES.md](https://github.com/acasadom/zypherdb/blob/main/THIRD_PARTY_NOTICES.md).

zypherdb-0.1.0/README.md

@@ -0,0 +1,134 @@
+# ZypherDB
+
+*An embedded graph database that speaks openCypher.*
+
+[![CI](https://github.com/acasadom/zypherdb/actions/workflows/ci.yml/badge.svg)](https://github.com/acasadom/zypherdb/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/acasadom/zypherdb/blob/main/LICENSE)
+![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+[![Docs](https://img.shields.io/badge/docs-acasadom.github.io%2Fzypherdb-blue)](https://acasadom.github.io/zypherdb/)
+
+ZypherDB is to graphs what SQLite is to tables: a database that lives inside your process and
+keeps its data in a directory, with no server to run. You store nodes and relationships and
+query them in **openCypher**, the language of Neo4j. Several processes can share a database, and
+a crash never leaves it half-written. The engine is written in Zig, on LMDB.
+
+## Install
+
+```bash
+pip install zypherdb
+```
+
+Python 3.10 or later, on Linux (x86_64, aarch64), macOS (Apple silicon, Intel) and Windows
+(x86_64). No dependencies (on Windows, only `tzdata`).
+
+## A first look
+
+Who may open a door, through groups nested to any depth, and at what times:
+
+```python
+from zypherdb import Database
+
+db = Database("lab.db")  # a directory, created if missing
+
+db.query("CREATE INDEX FOR (d:Door) ON (d.name)")  # doors are looked up by name
+db.query("""
+    CREATE (ana:Person {name: 'Ana'}), (bo:Person {name: 'Bo'}),
+           (staff:Group {name: 'Lab staff'}), (bsl3:Group {name: 'BSL-3'}),
+           (airlock:Door {name: 'BSL-3 airlock'})
+    CREATE (ana)-[:MEMBER_OF]->(bsl3)-[:PART_OF]->(staff),
+           (bo)-[:MEMBER_OF]->(staff),
+           (bsl3)-[:MAY_OPEN {from: localtime('07:00'), until: localtime('19:00')}]->(airlock)
+""")
+
+rows = db.query("""
+    MATCH (:Door {name: $door})<-[rule:MAY_OPEN]-(:Group)<-[:PART_OF*0..]-(:Group)<-[:MEMBER_OF]-(p:Person)
+    RETURN p.name, rule.from, rule.until
+""", door="BSL-3 airlock")
+print(rows)  # [['Ana', datetime.time(7, 0), datetime.time(19, 0)]]
+```
+
+Results come back as Python values: numbers, strings, lists, dicts, `datetime` types with their
+time zones, and nodes, relationships and paths.
+
+Full-text search, with stemming and BM25 ranking, in Neo4j's syntax:
+
+```python
+db.query("CREATE (:Protocol {title: 'Airlock', body: 'Spray the doors before opening them'})")
+db.query("""
+    CREATE FULLTEXT INDEX protocols FOR (p:Protocol) ON EACH [p.title, p.body]
+    OPTIONS {indexConfig: {`fulltext.analyzer`: 'english'}}
+""")
+print(db.query("""
+    CALL db.index.fulltext.queryNodes('protocols', 'door AND open') YIELD node, score
+    RETURN node.title, score
+"""))  # [['Airlock', 0.5753641449035617]]
+```
+
+And a look at how a query runs: `explain` returns its plan, and `profile` runs it and counts the
+rows each step made:
+
+```python
+def show(plan, depth=0):
+    print("  " * depth + f"{plan['operator']} {plan['details']}   rows: {plan['rows']}")
+    for child in plan["children"]:
+        show(child, depth + 1)
+
+rows, plan = db.profile("""
+    MATCH (:Door {name: $door})<-[rule:MAY_OPEN]-(:Group)<-[:PART_OF*0..]-(:Group)<-[:MEMBER_OF]-(p:Person)
+    RETURN p.name, rule.from, rule.until
+""", door="BSL-3 airlock")
+show(plan)
+```
+
+```text
+Return p.name, rule.from, rule.until   rows: 1
+  Expand(All) (:Group)<-[:MEMBER_OF]-(p:Person)   rows: 1
+    VarLengthExpand(All) (:Group)<-[:PART_OF*0..]-(:Group)   rows: 1
+      Expand(All) (:Door {name: $door})<-[rule:MAY_OPEN]-(:Group)   rows: 1
+        NodeIndexSeek (:Door {name: $door})   rows: 1
+```
+
+The [tutorial](https://acasadom.github.io/zypherdb/tutorial/01-getting-started.html) goes from
+here to a complete access-control system in twenty short steps.
+
+## What it can do
+
+- **openCypher**: `MATCH` and `OPTIONAL MATCH`, variable-length and shortest paths, `WITH`,
+  `UNWIND`, `UNION`, subqueries, `EXISTS { }` and `COUNT { }`; `CREATE`, `MERGE`, `SET`,
+  `REMOVE`, `DELETE`, `FOREACH`; `LOAD CSV`; every aggregate; string, list, math, temporal and
+  graph functions.
+- **Values**: integers, floats, strings, booleans, lists, maps, and the six temporal types with
+  time zones. Properties can also hold maps, so a node can carry a document.
+- **Indexes**: property indexes for equality and ranges, on node labels and relationship types,
+  and on fields inside documents; full-text indexes in English and Spanish; uniqueness constraints.
+- **Storage**: transactions, crash safety, three durability levels, one writer and any number of
+  readers across processes (readers never wait), and an integrity checker.
+- **Queries**: plans of operators with index seeks, `EXPLAIN` and `PROFILE`, prepared statements
+  and a statement cache.
+
+ZypherDB passes all 3202 scenarios of the [openCypher TCK](https://github.com/acasadom/zypherdb/blob/main/tests/tck/README.md)
+that expect a result, and all 694 that expect an error. The
+[Cypher reference](https://acasadom.github.io/zypherdb/guide/cypher.html) lists what it does not
+support yet. Python is the first language binding; C, C++ and JavaScript come next.
+
+## Documentation
+
+[acasadom.github.io/zypherdb](https://acasadom.github.io/zypherdb/) has the tutorial, the
+[Cypher](https://acasadom.github.io/zypherdb/guide/cypher.html) and
+[Python](https://acasadom.github.io/zypherdb/guide/python.html) references, and how it works
+inside: the [architecture](https://acasadom.github.io/zypherdb/guide/architecture.html), the
+storage layout, the query planner, [performance](https://acasadom.github.io/zypherdb/guide/performance.html)
+and [testing](https://acasadom.github.io/zypherdb/guide/testing.html) (fuzzers, crash and fault
+injection, the TCK).
+
+## Building from source
+
+You need [Zig 0.17](https://ziglang.org/download/): `zig build test` runs the tests and
+`pip install .` builds the Python package. The
+[contributing guide](https://acasadom.github.io/zypherdb/guide/contributing.html) has the rest.
+
+## License
+
+Apache License 2.0. ZypherDB includes LMDB, libmdbx, the IANA time-zone database, and data and
+algorithms from Unicode and Snowball, under their own licenses: see
+[THIRD_PARTY_NOTICES.md](https://github.com/acasadom/zypherdb/blob/main/THIRD_PARTY_NOTICES.md).

zypherdb-0.1.0/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,109 @@
+# Third-party notices
+
+ZypherDB includes, or is derived from, the following works. Their licenses are reproduced below.
+
+| Work | Where | License |
+| --- | --- | --- |
+| LMDB (Symas Corporation, OpenLDAP Foundation) | `vendor/lmdb/` | OpenLDAP Public License 2.8 (`vendor/lmdb/LICENSE`) |
+| libmdbx 0.14.4 (Leonid Yuriev), with the local change listed in `vendor/libmdbx/PATCHES.md` | `vendor/libmdbx/` | Apache License 2.0 (`vendor/libmdbx/LICENSE`; its NOTICE below) |
+| IANA time zone database 2026.5, as compiled to TZif by the tzdata Python package (Paul Ganssle, Stan Ulbrych) | `vendor/tzdata/` | The data is in the public domain; the package is under the Apache License 2.0 (`vendor/tzdata/LICENSE`, `vendor/tzdata/LICENSE_APACHE`) |
+| Unicode Character Database 16.0 (tables generated from it) | `src/text/unicode_tables.zig` | Unicode License v3 (below) |
+| Snowball stemming algorithms (English "Porter2", Spanish), translated to Zig; the Snowball Spanish stop-word list | `src/text/stem_english.zig`, `src/text/stem_spanish.zig`, `src/text/stop_words.zig` | BSD 3-Clause (below) |
+| Snowball test vocabularies (a sample) | `tests/text/snowball/` (tests only) | BSD 3-Clause (below) |
+| openCypher Technology Compatibility Kit | `tests/tck/features/` (tests only) | Apache License 2.0 (`tests/tck/LICENSE`) |
+
+The English stop words are Lucene's English stop set, a list of 33 common English words.
+
+## libmdbx (Apache License 2.0)
+
+ZypherDB's builds with the libmdbx engine (`-Dstorage-engine=mdbx`) contain libmdbx, compiled from
+`vendor/libmdbx/mdbx.c` as modified by ZypherDB (`vendor/libmdbx/PATCHES.md`). The
+attribution notice of its NOTICE file:
+
+```text
+libmdbx (aka MDBX) is an extremely fast, compact, powerful, embeddedable,
+transactional key-value storage engine with open-source code.
+
+Copyright 2015-2026 Леонид Юрьев aka Leonid Yuriev <leo@yuriev.ru>
+SPDX-License-Identifier: Apache-2.0
+For notes about the license change, credits and acknowledgments,
+please refer to the COPYRIGHT file within libmdbx source.
+```
+
+## Snowball (BSD 3-Clause)
+
+```text
+Copyright (c) 2001, Dr Martin Porter
+Copyright (c) 2004,2005, Richard Boulton
+Copyright (c) 2013, Yoshiki Shibukawa
+Copyright (c) 2006-2025, Olly Betts
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+  1. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright notice,
+     this list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+  3. Neither the name of the Snowball project nor the names of its contributors
+     may be used to endorse or promote products derived from this software
+     without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+
+## Unicode License v3
+
+```text
+UNICODE LICENSE V3
+
+COPYRIGHT AND PERMISSION NOTICE
+
+Copyright © 1991-2026 Unicode, Inc.
+
+NOTICE TO USER: Carefully read the following legal agreement. BY
+DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING DATA FILES, AND/OR
+SOFTWARE, YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE
+TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE, DO NOT
+DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE THE DATA FILES OR SOFTWARE.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of data files and any associated documentation (the "Data Files") or
+software and any associated documentation (the "Software") to deal in the
+Data Files or Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, and/or sell
+copies of the Data Files or Software, and to permit persons to whom the
+Data Files or Software are furnished to do so, provided that either (a)
+this copyright and permission notice appear with all copies of the Data
+Files or Software, or (b) this copyright and permission notice appear in
+associated Documentation.
+
+THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
+THIRD PARTY RIGHTS.
+
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE
+BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES,
+OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA
+FILES OR SOFTWARE.
+
+Except as contained in this notice, the name of a copyright holder shall
+not be used in advertising or otherwise to promote the sale, use or other
+dealings in these Data Files or Software without prior written
+authorization of the copyright holder.
+```