cypher-shell

Name	cypher-shell JSON
Version	0.1 JSON
	download
home_page	None
Summary	Cypher Shell -- a shell for querying Neo4j with Cypher
upload_time	2024-10-24 07:24:51
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 --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.

            

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/c9/dd/87497443daea81233211e534ea565edc90fd2b9f78c0c0203395b663d42b/cypher_shell-0.1.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 --config 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",
    "bugtrack_url": null,
    "license": null,
    "summary": "Cypher Shell -- a shell for querying Neo4j with Cypher",
    "version": "0.1",
    "project_urls": {
        "Source": "https://github.com/LemurPwned/cypher-shell"
    },
    "split_keywords": [
        "cypher",
        " neo4j",
        " querying",
        " shell",
        " llm"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8d5d1995736d3a86e5db379f702473bceb1fe50e021035fdddefcce18d4821f1",
                "md5": "b5d9a82a52d279787f7584486527795c",
                "sha256": "d1305ce05dcc0b206abaa91fff3ce90572e09202c5f23481d5918661266844ad"
            },
            "downloads": -1,
            "filename": "cypher_shell-0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b5d9a82a52d279787f7584486527795c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.10",
            "size": 8249,
            "upload_time": "2024-10-24T07:24:49",
            "upload_time_iso_8601": "2024-10-24T07:24:49.619760Z",
            "url": "https://files.pythonhosted.org/packages/8d/5d/1995736d3a86e5db379f702473bceb1fe50e021035fdddefcce18d4821f1/cypher_shell-0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c9dd87497443daea81233211e534ea565edc90fd2b9f78c0c0203395b663d42b",
                "md5": "db892f9cfef2a58c8d309cebf8b5ba8e",
                "sha256": "172cb8829c8fa176cf4567f5db6cf275f650efddcecf734c0f4de1d10987b165"
            },
            "downloads": -1,
            "filename": "cypher_shell-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "db892f9cfef2a58c8d309cebf8b5ba8e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.10",
            "size": 8829,
            "upload_time": "2024-10-24T07:24:51",
            "upload_time_iso_8601": "2024-10-24T07:24:51.050061Z",
            "url": "https://files.pythonhosted.org/packages/c9/dd/87497443daea81233211e534ea565edc90fd2b9f78c0c0203395b663d42b/cypher_shell-0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-24 07:24:51",
    "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"
}