Metadata-Version: 2.1
Name: cypher-shell
Version: 0.1
Summary: Cypher Shell -- a shell for querying Neo4j with Cypher
Keywords: cypher,neo4j,querying,shell,llm
Author-email: LemurPwned <lemurpwned@gmail.com>
Requires-Python: >3.10
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: pyyaml
Requires-Dist: python-dotenv
Requires-Dist: swarm
Project-URL: Source, https://github.com/LemurPwned/cypher-shell

# Cypher Shell

A shell for querying Neo4j with Cypher using LLMs.

## Installation

```bash
pip install cypher-shell
```

## How to use

```bash
python -m cypher_shell --help
```

or

```bash
python -m cypher_shell --config 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.

