cypher-shell

Name	cypher-shell JSON
Version	0.3 JSON
	download
home_page	None
Summary	Cypher Shell -- a shell for querying Neo4j with Cypher
upload_time	2024-12-29 19:47:39
maintainer	None
docs_url	None
author	None
requires_python	>3.10
license	None
keywords	cypher neo4j querying shell llm
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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 --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.

```bash
docker run --env .env -it ghcr.io/lemurpwned/cypher-shell:latest python3 -m cypher_shell --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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cypher-shell",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">3.10",
    "maintainer_email": null,
    "keywords": "cypher, neo4j, querying, shell, llm",
    "author": null,
    "author_email": "LemurPwned <lemurpwned@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/b5/7a/5b4c48278b83dc3740a9f5e805db36f5bce442e28f11795e9872fe7f5375/cypher_shell-0.3.tar.gz",
    "platform": null,
    "description": "# Cypher Shell\n\nA shell for querying Neo4j with Cypher using LLMs.\n\n## Installation\n\n```bash\npip install cypher-shell\n```\n\n## How to use\n\n```bash\npython -m cypher_shell --help\n```\n\nor\n\n```bash\npython -m cypher_shell --cfg-path configs/movies.yaml\n```\n\nwhere `configs/movies.yaml` is a configuration file that contains the node and relationship descriptions.\n\nIf no configuration file is provided, the tool will try to generate a schema automatically. This might give worse results.\n\nYou need to set the `.env` file with your OpenAI API key and Neo4j credentials. See `.env_template` for more information.\n\n### Docker\n\nYou can also run the tool using Docker.\n\n```bash\ndocker run --env .env -it ghcr.io/lemurpwned/cypher-shell:latest python3 -m cypher_shell --cfg-path configs/movies.yaml\n```\n\n### Run query without LLM\n\nJust preface the query with: `cs:` and the query will not be rewritten by the llm.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Cypher Shell -- a shell for querying Neo4j with Cypher",
    "version": "0.3",
    "project_urls": {
        "Source": "https://github.com/LemurPwned/cypher-shell"
    },
    "split_keywords": [
        "cypher",
        " neo4j",
        " querying",
        " shell",
        " llm"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "77aca9ae86376ac976b60cd33648baa16e19e7b0e7760aa9a57030397cf3432a",
                "md5": "c01cb318e7caf41adc64f88be652ddd5",
                "sha256": "48e4dc0580751ac9bff61a5531ee78619607d217e48145d9d84ed9581b901cd3"
            },
            "downloads": -1,
            "filename": "cypher_shell-0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c01cb318e7caf41adc64f88be652ddd5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.10",
            "size": 9957,
            "upload_time": "2024-12-29T19:47:38",
            "upload_time_iso_8601": "2024-12-29T19:47:38.349481Z",
            "url": "https://files.pythonhosted.org/packages/77/ac/a9ae86376ac976b60cd33648baa16e19e7b0e7760aa9a57030397cf3432a/cypher_shell-0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b57a5b4c48278b83dc3740a9f5e805db36f5bce442e28f11795e9872fe7f5375",
                "md5": "501269e8a054ca4506ec7fb923c0243b",
                "sha256": "c8194c880bcb4ad9057d226530b09ba65257c9e7f489f02c526389e68ce5f730"
            },
            "downloads": -1,
            "filename": "cypher_shell-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "501269e8a054ca4506ec7fb923c0243b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.10",
            "size": 11145,
            "upload_time": "2024-12-29T19:47:39",
            "upload_time_iso_8601": "2024-12-29T19:47:39.382380Z",
            "url": "https://files.pythonhosted.org/packages/b5/7a/5b4c48278b83dc3740a9f5e805db36f5bce442e28f11795e9872fe7f5375/cypher_shell-0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-29 19:47:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "LemurPwned",
    "github_project": "cypher-shell",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cypher-shell"
}