| Name | ICICONSOLE-GPT JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | GPT Powered Command-line Interface tailored to working with Neo4j Knowledge Graph Databses hosted via Tapis Pods. |
| upload_time | 2023-06-29 23:43:31 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Sahil Samar Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
tapis
cli
agave
hpc
tapis pods
tacc
neo4j
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ICICONSOLE-GPT
## Overview
ICICONSOLE is designed to provide an efficient and powerful interface to Neo4j Knowledge Graph databases hosted on HPC resources, leveraging Tapis.
This application is specialized for knowledge graph querying, and has some basic CYPHER commands built in.
The difference between ICICONSOLE-GPT and ICICONSOLE is the integration of GPT-3.5 via the OpenAI API. Note that this means to access these features, an OpenAI API key is required; if you don't have one, you can use the rest of the ICICONSOLE features normally.
### Installation
Requires Python 3.10 or higher. You can clone this repository and manually install the requirements, or you can directly install the application from PyPi.
```shell
pip install ICICONSOLE-GPT
```
```shell
python -m ICICONSOLE-GPT
```
**OR**
```shell
git clone https://github.com/sdsc-hpc-training-org/hello_icicle_auth_clients.git
```
```shell
cd ICICONSOLE/ICICONSOLE_GPT/ICICONSOLE/
```
```shell
pip install pandas
```
```shell
pip install py2neo
```
```shell
pip install tapipy
```
```shell
pip install datascroller
```
```shell
pip install openai
```
```shell
python __main__.py
```
### First time user guide
You will be asked to login with your TACC account. If you aren't sure if you have this, visit the TACC [portal](https://portal.tacc.utexas.edu/).
Next, you will see the Tapis Pods that you have been given permission to access. If you don't see any, please contact the owner of the Pod you wish to access. Type in the ID of the Pod that you want to access.
Once you do this, you will be in a custom made console for interfacing with the Knowledge Graph, using the Cypher language. If you know Cypher, you can start typing in commands like
```
MATCH(n) RETURN n LIMIT 10
```
If you are not familiar with Cypher, don't worry! This is meant for users who have never used Cypher before. Type in "help" to view some of the built in commands to start exploring the knowledge graph. These built in commands will grow more extensive as time goes on.
The welcome message for the Knowledge Graph console contains helpful tips, like "new", "exit", "clear", and "help".
Raw data
{
"_id": null,
"home_page": "",
"name": "ICICONSOLE-GPT",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "Tapis,CLI,Agave,HPC,Tapis Pods,TACC,Neo4j",
"author": "",
"author_email": "Sahil Samar <sahilsamar031@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/fb/6d8fc33fd7cb7e7965efcb8626cc2620b9c3036e5c05f753c8654737d143/ICICONSOLE-GPT-0.0.2.tar.gz",
"platform": null,
"description": "# ICICONSOLE-GPT\n\n## Overview\n\nICICONSOLE is designed to provide an efficient and powerful interface to Neo4j Knowledge Graph databases hosted on HPC resources, leveraging Tapis. \n\nThis application is specialized for knowledge graph querying, and has some basic CYPHER commands built in. \n\nThe difference between ICICONSOLE-GPT and ICICONSOLE is the integration of GPT-3.5 via the OpenAI API. Note that this means to access these features, an OpenAI API key is required; if you don't have one, you can use the rest of the ICICONSOLE features normally.\n\n### Installation\n\nRequires Python 3.10 or higher. You can clone this repository and manually install the requirements, or you can directly install the application from PyPi.\n\n```shell \npip install ICICONSOLE-GPT\n```\n\n```shell\npython -m ICICONSOLE-GPT\n```\n\n**OR**\n\n```shell \ngit clone https://github.com/sdsc-hpc-training-org/hello_icicle_auth_clients.git\n```\n\n```shell\ncd ICICONSOLE/ICICONSOLE_GPT/ICICONSOLE/\n```\n\n```shell\npip install pandas\n```\n\n```shell\npip install py2neo\n```\n\n```shell\npip install tapipy\n```\n\n```shell\npip install datascroller\n```\n\n```shell\npip install openai\n```\n\n```shell\npython __main__.py\n```\n\n### First time user guide\n\nYou will be asked to login with your TACC account. If you aren't sure if you have this, visit the TACC [portal](https://portal.tacc.utexas.edu/).\n\nNext, you will see the Tapis Pods that you have been given permission to access. If you don't see any, please contact the owner of the Pod you wish to access. Type in the ID of the Pod that you want to access. \n\nOnce you do this, you will be in a custom made console for interfacing with the Knowledge Graph, using the Cypher language. If you know Cypher, you can start typing in commands like \n\n```\nMATCH(n) RETURN n LIMIT 10\n```\n\nIf you are not familiar with Cypher, don't worry! This is meant for users who have never used Cypher before. Type in \"help\" to view some of the built in commands to start exploring the knowledge graph. These built in commands will grow more extensive as time goes on. \n\nThe welcome message for the Knowledge Graph console contains helpful tips, like \"new\", \"exit\", \"clear\", and \"help\". \n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Sahil Samar Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "GPT Powered Command-line Interface tailored to working with Neo4j Knowledge Graph Databses hosted via Tapis Pods.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/AD1616/ICICONSOLE/tree/main/ICICONSOLE_GPT"
},
"split_keywords": [
"tapis",
"cli",
"agave",
"hpc",
"tapis pods",
"tacc",
"neo4j"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ffde1a9e27a6fbd6e8c0895023e9c8891b57f195d9b1ec3554e5ba65643dc64",
"md5": "027955162dfbe98dc62097f4ca6c9935",
"sha256": "440dcc514f3f357d3fb80a2c9d2f1d37e59e0591e5351f3e6997a67a9a3f4f54"
},
"downloads": -1,
"filename": "ICICONSOLE_GPT-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "027955162dfbe98dc62097f4ca6c9935",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8581,
"upload_time": "2023-06-29T23:43:29",
"upload_time_iso_8601": "2023-06-29T23:43:29.617437Z",
"url": "https://files.pythonhosted.org/packages/9f/fd/e1a9e27a6fbd6e8c0895023e9c8891b57f195d9b1ec3554e5ba65643dc64/ICICONSOLE_GPT-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ffb6d8fc33fd7cb7e7965efcb8626cc2620b9c3036e5c05f753c8654737d143",
"md5": "b25007deb5707c1c741cc91117674270",
"sha256": "b18d3c6e4dae21c6c919c3b95367c5d91c79189202569c8bb47db8620b95dd4b"
},
"downloads": -1,
"filename": "ICICONSOLE-GPT-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "b25007deb5707c1c741cc91117674270",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7307,
"upload_time": "2023-06-29T23:43:31",
"upload_time_iso_8601": "2023-06-29T23:43:31.030884Z",
"url": "https://files.pythonhosted.org/packages/6f/fb/6d8fc33fd7cb7e7965efcb8626cc2620b9c3036e5c05f753c8654737d143/ICICONSOLE-GPT-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-29 23:43:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AD1616",
"github_project": "ICICONSOLE",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "iciconsole-gpt"
}
