Skip to main content

Cypher Shell -- a shell for querying Neo4j with Cypher

Project description

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 --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 --cfg-path configs/movies.yaml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cypher_shell-0.2.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cypher_shell-0.2-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file cypher_shell-0.2.tar.gz.

File metadata

  • Download URL: cypher_shell-0.2.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for cypher_shell-0.2.tar.gz
Algorithm Hash digest
SHA256 cf5091b52a905c7df56a60ebf3a2dc77ab51894484bb02617219f2cb9dcd8964
MD5 d94a0387a63541c11de91da63bc65d5f
BLAKE2b-256 b7ccbeed7c068a440a0c2b1f68d34794df2fd9a1086e3b296f006c4b26222232

See more details on using hashes here.

File details

Details for the file cypher_shell-0.2-py3-none-any.whl.

File metadata

  • Download URL: cypher_shell-0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for cypher_shell-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6920e1a41e4f84140f6619d3f69b8f387d02b2ca590f5abbadf574ce4566c671
MD5 29be03e14d3bcd429cdb40207af953ea
BLAKE2b-256 5ccc98e6fdd482380b392fe884773ffb945229f13dd13248e262512ffa0b3125

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page