Cypher Shell
A shell for querying Neo4j with Cypher using LLMs.
Installation
pip install cypher-shell
How to use
python -m cypher_shell --help
or
python -m cypher_shell run --cfg-path configs/movies.yaml
where configs/movies.yaml is a configuration file that contains the node and relationship descriptions.
If no configuration file is provided, the tool will try to generate a schema automatically. This might give worse results.
You need to set the .env file with your OpenAI API key and Neo4j credentials. See .env_template for more information.
Docker
You can also run the tool using Docker.
docker run --env .env -it ghcr.io/lemurpwned/cypher-shell:latest python3 -m cypher_shell run --cfg-path configs/movies.yaml
Run query without LLM
Just preface the query with: cs: and the query will not be rewritten by the llm.
Notes:
- sometimes getting the schema automatically is better than providing it manually.
1 maintainer
Metadata
1 maintainer
Release files for cypher-shell 0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cypher_shell-0.5.tar.gz | 11.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cypher_shell-0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.1 kB
Release files / cypher_shell-0.5.tar.gz
| Download URL | cypher_shell-0.5.tar.gz |
|---|---|
| Size | 11.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
98dc326e99824ac075ae769904e3e51b834e17f74e4f31d7843fd502ca4e9f9b
|
|
BLAKE2b-256 checksum How to use checksums |
c16e86cc8f6d8eb04251bfe7c589053f1c1e13029ab1b71f35d768afc1a5457e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.3
|
Release files / cypher_shell-0.5-py3-none-any.whl
| Download URL | cypher_shell-0.5-py3-none-any.whl |
|---|---|
| Size | 11.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
65f49f1334f73384f4051c036978ea3d0abc1b631d4e24475417b5aa697aae5d
|
|
BLAKE2b-256 checksum How to use checksums |
aa8dd3b02c1b38a7d8dcbd8bd2ec5e40b1ee39182f533ea769a5aaed8e23f29f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.3
|
