# WebAssistant
Easily deploy an AI assistant chatbot for your personal website.
This repository contains a Python library and the template for a React app, both of which use state-of-the-art Retrieval Augmented Generation (RAG) prompting methodologies.
## Prerequisites
1. Make sure you have an OpenAI API key
2. Have the base URL of the website for which you want to create the chatbot
## Using the Python Library
To use the python library, first install with
```bash
pip install WebAssistant
```
Then, write
```python
from WebAssistant import *
myChatbot = Hub()
myChatbot.launch(YOUR_OPENAI_API_KEY, YOUR_WEBSITE)
```
This will create a link to a chatbot built with Gradio that can answer questions about your website.
If you're looking for a very basic (and not recommended) solution, simply iframe the link on your webpage. Note that the link will expire every 3 days and will need to be regenerated using ``launch()``
## Using the React App
For a more flexible solution, run the following Python code. Make sure you have node installed first.
```python
from WebAssistant import *
myChatbot = Hub()
myChatbot.deployReactExpressApp(YOUR_OPENAI_API_KEY, YOUR_WEBSITE, YOUR_ROOT_DIRECTORY)
```
This will deploy a React frontend + Express backend to ``localhost:8080``. From there, you can upload it to Cloudflare, Render.com, Fly.io, Railway, or other providers, and then iframe the link generated by those sites inside a dedicated container in your website for the chatbot.
Note that you must NOT remove the credits to this repository included at the bottom of the chatbot UI.
## Questions?
Feel free to send any questions you have through the issues tab on Github.
Raw data
{
"_id": null,
"home_page": "https://github.com/shreyanmitra/WebAssistant",
"name": "WebAssistant",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "ai chatbot website-builder gpt-4 rag",
"author": "Shreyan Mitra",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/98/dc/e7108987056215879fbade9cae122674a8c6dd7d172a46f0a3f04483f08d/webassistant-0.0.4.tar.gz",
"platform": null,
"description": "# WebAssistant\n\nEasily deploy an AI assistant chatbot for your personal website.\n\nThis repository contains a Python library and the template for a React app, both of which use state-of-the-art Retrieval Augmented Generation (RAG) prompting methodologies.\n\n## Prerequisites\n1. Make sure you have an OpenAI API key\n2. Have the base URL of the website for which you want to create the chatbot\n\n## Using the Python Library\n\nTo use the python library, first install with\n\n```bash\npip install WebAssistant\n```\n\nThen, write\n\n```python\nfrom WebAssistant import *\nmyChatbot = Hub()\nmyChatbot.launch(YOUR_OPENAI_API_KEY, YOUR_WEBSITE)\n```\n\nThis will create a link to a chatbot built with Gradio that can answer questions about your website.\n\nIf you're looking for a very basic (and not recommended) solution, simply iframe the link on your webpage. Note that the link will expire every 3 days and will need to be regenerated using ``launch()``\n\n## Using the React App\nFor a more flexible solution, run the following Python code. Make sure you have node installed first.\n\n```python\nfrom WebAssistant import *\nmyChatbot = Hub()\nmyChatbot.deployReactExpressApp(YOUR_OPENAI_API_KEY, YOUR_WEBSITE, YOUR_ROOT_DIRECTORY)\n```\n\nThis will deploy a React frontend + Express backend to ``localhost:8080``. From there, you can upload it to Cloudflare, Render.com, Fly.io, Railway, or other providers, and then iframe the link generated by those sites inside a dedicated container in your website for the chatbot.\n\nNote that you must NOT remove the credits to this repository included at the bottom of the chatbot UI.\n\n## Questions?\nFeel free to send any questions you have through the issues tab on Github.\n",
"bugtrack_url": null,
"license": null,
"summary": "WebAssistant: Quickly Deploy an AI Assistant Chatbot for your Personal Webpage",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/shreyanmitra/WebAssistant"
},
"split_keywords": [
"ai",
"chatbot",
"website-builder",
"gpt-4",
"rag"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7dbedd9c625d342f3db396992374c6304e0d8bff488d2fca7236a0b5135a4475",
"md5": "3e47e6b1912ae016112ba354b6fdbd76",
"sha256": "2ca199a87c2d68ed16b9f25cc08a48dda183c59056a78b82708ab5305a88b18c"
},
"downloads": -1,
"filename": "WebAssistant-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e47e6b1912ae016112ba354b6fdbd76",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5187,
"upload_time": "2024-09-10T01:22:24",
"upload_time_iso_8601": "2024-09-10T01:22:24.833768Z",
"url": "https://files.pythonhosted.org/packages/7d/be/dd9c625d342f3db396992374c6304e0d8bff488d2fca7236a0b5135a4475/WebAssistant-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98dce7108987056215879fbade9cae122674a8c6dd7d172a46f0a3f04483f08d",
"md5": "1a971756b6935ecb3d90bced136d4ff7",
"sha256": "b182a5fdd98216c25a36184a266ce6750b5d0c4917443afd6809527a2c7c70e7"
},
"downloads": -1,
"filename": "webassistant-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "1a971756b6935ecb3d90bced136d4ff7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4761,
"upload_time": "2024-09-10T01:22:26",
"upload_time_iso_8601": "2024-09-10T01:22:26.396194Z",
"url": "https://files.pythonhosted.org/packages/98/dc/e7108987056215879fbade9cae122674a8c6dd7d172a46f0a3f04483f08d/webassistant-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-10 01:22:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shreyanmitra",
"github_project": "WebAssistant",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "webassistant"
}
JSON
