nxcypher 1.0.0__tar.gz

nxcypher-1.0.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: Bug Report
+about: Report a bug in nxCypher
+title: '[BUG] '
+labels: bug
+---
+
+## Description
+
+A clear description of what the bug is.
+
+## Cypher Query
+
+```cypher
+MATCH (n) RETURN n
+```
+
+## Expected Behavior
+
+What you expected to happen.
+
+## Actual Behavior
+
+What actually happened. Include the error message or incorrect output.
+
+## Minimal Reproduction
+
+```python
+import networkx as nx
+from nxcypher import NXCypher
+
+G = nx.DiGraph()
+# ... setup graph ...
+
+result = NXCypher(G).run("YOUR QUERY HERE")
+print(result)
+```
+
+## Environment
+
+- Python version:
+- nxCypher version:
+- NetworkX version:
+- OS:

nxcypher-1.0.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,31 @@
+---
+name: Feature Request
+about: Suggest a new Cypher feature or function
+title: '[FEATURE] '
+labels: enhancement
+---
+
+## Feature Description
+
+A clear description of the feature you'd like to see.
+
+## Cypher Reference
+
+If this is a standard Cypher/OpenCypher feature, link to the relevant documentation:
+- Neo4j docs: https://neo4j.com/docs/cypher-manual/current/
+- OpenCypher spec: https://opencypher.org/
+
+## Example Query
+
+```cypher
+-- Show how the feature would be used
+MATCH (n) RETURN newFunction(n.property)
+```
+
+## Expected Result
+
+Describe what the query should return.
+
+## Use Case
+
+Why is this feature important for your use case?

nxcypher-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+## Description
+
+Brief description of the changes.
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature (Cypher function, clause, etc.)
+- [ ] Performance improvement
+- [ ] Documentation update
+- [ ] Other (describe):
+
+## Checklist
+
+- [ ] All tests pass (`uv run pytest nxcypher/ -v`)
+- [ ] Linter passes (`uv run ruff check nxcypher/`)
+- [ ] New tests added for new functionality
+- [ ] All commits are signed off (DCO: `git commit -s`)
+
+## Testing
+
+Describe how you tested these changes:
+
+```python
+# Example test or query used to verify
+```

nxcypher-1.0.0/.github/SECURITY.md

@@ -0,0 +1,36 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x     | Yes                |
+| < 1.0   | No                 |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in nxCypher, please report it responsibly.
+
+**Do NOT open a public GitHub issue for security vulnerabilities.**
+
+Instead, please use one of these methods:
+
+1. **GitHub Security Advisories** (preferred): Navigate to the repository's "Security" tab and click "Report a vulnerability"
+2. **Email**: Contact the maintainers directly
+
+### What to Include
+
+- Description of the vulnerability
+- Steps to reproduce
+- Potential impact
+- Suggested fix (if any)
+
+### Response Timeline
+
+- **Acknowledgment**: Within 48 hours
+- **Initial assessment**: Within 1 week
+- **Fix or mitigation**: Depends on severity, but we aim for 30 days for critical issues
+
+### Disclosure
+
+We follow a coordinated disclosure process. Please allow us reasonable time to address the issue before making it public.

nxcypher-1.0.0/.github/workflows/dco.yml

@@ -0,0 +1,12 @@
+name: DCO Check
+
+on:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  dco:
+    runs-on: ubuntu-latest
+    steps:
+      - name: DCO Check
+        uses: tisonkun/actions-dco@v1.2

nxcypher-1.0.0/.github/workflows/python-package.yml

@@ -0,0 +1,52 @@
+name: Test and lint
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
+      - name: Cache virtual environment
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ matrix.python-version }}-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: |
+            venv-${{ matrix.python-version }}-
+
+      - name: Set up uv venv and install dependencies
+        run: |
+          uv venv
+          source .venv/bin/activate
+          uv pip install ruff pytest
+          uv pip install -e .
+
+      - name: Lint with ruff
+        run: |
+          source .venv/bin/activate
+          ruff check nxcypher
+
+      - name: Test with pytest
+        run: |
+          source .venv/bin/activate
+          pytest nxcypher/ -v

nxcypher-1.0.0/.gitignore

@@ -0,0 +1,201 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos,linux,python,vscode
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,linux,python,vscode
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+pythonenv*
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# profiling data
+.prof
+
+### vscode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Claude Code
+.claude/
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,linux,python,vscode
+

nxcypher-1.0.0/.ruff.toml

@@ -0,0 +1,6 @@
+# .ruff.toml
+exclude = ["tests/fixtures", ".venv", "build", "dist"]
+
+[lint]
+select = ["E", "F", "W"]
+ignore = ["E731", "E501", "E722"]

nxcypher-1.0.0/CHANGELOG.md

@@ -0,0 +1,198 @@
+# CHANGELOG
+
+> Note: Versions prior to 1.0.0-nxcypher are from the original
+> [GrandCypher](https://github.com/aplbrain/grand-cypher) project.
+
+### **1.0.0-nxcypher** (February 2026)
+
+#### nxCypher Fork
+
+-   Renamed project from GrandCypher to nxCypher
+-   `COUNT(*)` aggregate support
+-   `DISTINCT` inside aggregate functions (`COUNT(DISTINCT x)`, `COLLECT(DISTINCT x)`, etc.)
+-   `OPTIONAL MATCH` clause
+-   `WITH` clause
+-   `UNWIND` clause
+-   `MERGE` clause with `ON CREATE` / `ON MATCH`
+-   `REMOVE` clause
+-   `UNION` / `UNION ALL`
+-   `CASE` expressions (searched and simple)
+-   List comprehensions
+-   String functions (`toLower`, `toUpper`, `trim`)
+-   List functions (`size`, `head`, `tail`)
+-   Type functions (`type`, `labels`, `keys`)
+-   Graph mutations (`CREATE`, `SET`, `DELETE`, `DETACH DELETE`)
+-   Negated edges (`WHERE NOT (a)-->(b)`)
+-   `COLLECT()` aggregation
+-   Knowledge base loader (`kb_loader.py`)
+-   Apache 2.0 compliance files (NOTICE, DCO, governance)
+
+---
+
+### **1.0.1** (September 23, 2025)
+
+### Features
+
+-   Support for `|` operator in node labels (#79, thanks @ericnwrites!)
+
+### **1.0.0** (May 23, 2025)
+
+#### Breaking Changes
+
+-   The `RETURN` clause on nodes now returns a list of dictionaries instead of a list of IDs. This is compatible with the actual Cypher spec, but breaks compatibility with the previous version. For more information, see #73 and #57.
+-   Migrate to `uv` for package management (#74)
+
+### **0.14.0** (March 18 2025)
+
+#### Features
+
+-   Support for `hints` in the `run` method (#67)
+
+### **0.13.0** (February 17 2025)
+
+#### Housekeeping
+
+-   Remove EOL Python 3.7 and 3.8 from CI, and adds 3.12 and 3.13 (#66, thanks @davidmezzetti!)
+
+#### Features
+
+-   Support for `IN` clause (#66, thanks @davidmezzetti!)
+
+#### Fixes
+
+-   Fix regression in `null` / `true` / `false` (#66, thanks @davidmezzetti!)
+
+### **0.12.0** (January 10 2025)
+
+#### Housekeeping
+
+-   Switch to maintained `lark` parser (#60, thanks @ntjess!)
+
+### **0.11.0** (December 4 2024)
+
+#### Features
+
+-   Support multidigraph/digraph without up-conversion (#55, thanks @jackboyla!)
+
+### **0.10.0** (October 18 2024)
+
+> Bugfix for searching multigraphs, and other improvements for multigraphs.
+
+#### Features
+
+-   Aliasing (`RETURN SUM(r.value) AS myvalue`) (#46, thanks @jackboyla!)
+
+#### Fixes
+
+-   Fix bug in searching multigraphs where unwanted edges between returned nodes were returned (#48, thanks @jackboyla!)
+-   Unify digraph and multigraph implementations (#46, thanks @jackboyla!)
+
+### **0.9.0** (June 11 2024)
+
+> Support for aggregate functions like `COUNT`, `SUM`, `MIN`, `MAX`, and `AVG`.
+
+#### Features
+
+-   Support for aggregate functions like `COUNT`, `SUM`, `MIN`, `MAX`, and `AVG` (#45, thanks @jackboyla!)
+-   Logical `OR` support in relationship matches (#44, thanks @jackboyla!)
+
+#### Testing
+
+-   Combine tests for digraphs and multidigraphs (#43, thanks @jackboyla!)
+
+### **0.8.0** (May 14 2024)
+
+> Support for MultiDiGraphs.
+
+#### Features
+
+-   Support for MultiDiGraphs (#42, thanks @jackboyla!)
+
+### **0.7.0** (May 4 2024)
+
+> Support for `ORDER BY` and `DISTINCT`
+
+#### Features
+
+-   Support for `ORDER BY` in queries, including `ASC` and `DESC`, and chaining multiple sorts (#41, thanks @jackboyla!)
+-   Support for `DISTINCT` in queries (#40, thanks @jackboyla!)
+
+#### Housekeeping
+
+-   Refactor `return` for readability (#41, thanks @jackboyla!)
+
+### **0.6.0** (February 15 2024)
+
+> New path group operator
+
+#### Features
+
+-   Support for path group operators (#37)
+
+### **0.5.0** (February 13 2024)
+
+> Lots of language support for new query operators.
+
+#### Features
+
+-   Support for C-style comments in queries with `//` (#31)
+-   Support for string operators, like `CONTAINS`, `STARTS WITH`, and `ENDS WITH` (#33)
+-   Support for negation of clauses with `NOT` (#33)
+
+#### Performance
+
+-   Huge performance boost for nonexhaustive queries via streaming matches (#34, thanks @davidmezzetti!)
+
+#### Housekeeping
+
+-   Added more recent version of Python (3.9 through 3.11) to CI (#33)
+
+### **0.4.0** (October 17 2023)
+
+> Many performance updates, language features, and label support.
+
+#### Features
+
+-   Support for multi-hop queries in `MATCH` statements (#24, thanks @khoale88!)
+-   Support for single edge and node labels using the `__labels__` magic property (#25, thanks @khoale88!)
+
+#### Performance
+
+-   Performance improvements by @khoale88 that eliminate duplicated entity lookups (#28)
+
+### **0.3.0** (December 14 2022)
+
+> This version adds support for boolean arithmetic with AND/OR, and other language features.
+
+#### Features
+
+-   Support for boolean arithmetic with AND/OR (#20, thanks @khoale88!)
+-   Support for undirected edges (`(A)-[]-(B)`)
+
+#### Housekeeping
+
+-   Add install dependencies to `setup.py`
+
+### **0.2.0** (December 12 2022)
+
+> Lots of great new language support by @khoale88, thank you!!
+
+#### Performance
+
+-   Improves performance of the `limit` argument by offloading the result-limiting behavior to `grandiso`.
+
+#### Features
+
+-   Add behavior for disconnected matches of multiple graph components (#17, thanks @khoale88!)
+-   Add support for anonymous nodes (#16, thanks @khoale88!)
+-   Support chained edges like `(A)-[]->(B)-[]-(C)` (#15, thanks @khoale88!)
+-   Support backwards edges (#14, thanks @khoale88!)
+-   Support `NULL` and the `is` operator in queriy `WHERE` and property queries (#13, thanks @khoale88!)
+
+### **0.1.1** (October 1 2021)
+
+> This version adds support for node-only matches.
+
+### **0.1.0** (March 23 2021)
+
+> This version adds initial support for querying networkx-flavored graphs with the Cypher query language.

nxcypher-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,85 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+