Merge pull request #29 from momegas/general_fixes

.gitattributes

@@ -0,0 +1,2 @@
+# Ignore Jupyter notebooks from Git stats
+*.ipynb linguist-documentation

.gitignore

@@ -1,4 +1,4 @@
-.venv
+# General
 __pycache__
 .pytest_cache
 **.egg-info
@@ -6,6 +6,37 @@ dist
 build
 **.pickle
 **.pkl
-.env
 volumes
-docker-compose.yml
+docker-compose.yml
+
+# Environments
+.venv
+.env
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Jupyter Notebook checkpoints
+.ipynb_checkpoints

README.md

@@ -1,8 +1,12 @@
 # 🤖 Megabots
 
 [![Tests](https://github.com/momegas/qnabot/actions/workflows/python-package.yml/badge.svg)](https://github.com/momegas/qnabot/actions/workflows/python-package.yml)
+[![Python Version](https://img.shields.io/badge/python-%203.10%20-blue.svg)](#supported-python-versions) 
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![License](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/momegas/megabots/blob/main/LICENCE)
 ![](https://dcbadge.vercel.app/api/server/zkqDWk5S7P?style=flat&n&compact=true)
 
+
 🤖 Megabots provides State-of-the-art, production ready LLM apps made mega-easy, so you don't have to build them from scratch 🤯 Create a bot, now 🫵
 
 - 👉 Join us on Discord: https://discord.gg/zkqDWk5S7P
@@ -40,7 +44,8 @@ import os
 
 os.environ["OPENAI_API_KEY"] = "my key"
 
-# Create a bot 👉 with one line of code. Automatically loads your data from ./index or index.pkl.
+# Create a bot 👉 with one line of code. Automatically loads your data from ./index or index.pkl. 
+# Keep in mind that you need to have one or another.
 qnabot = bot("qna-over-docs")
 
 # Ask a question
@@ -239,3 +244,9 @@ sequenceDiagram
     API -->> User: Return response
 
 ```
+## How to contribute?
+
+We welcome any suggestions, problem reports, and contributions!
+For any changes you would like to make to this project, we invite you to submit an [issue](https://github.com/momegas/megabots/issues).
+
+For more information, see [`CONTRIBUTING`](https://github.com/momegas/megabots/blob/main/CONTRIBUTING.md) instructions.

example.ipynb

@@ -19,7 +19,7 @@
     "\n",
     "The `bot` object is the main object of the library. It is used to create a bot and to interact with it.\n",
     "\n",
-    "The `index` argument specifies the index to use for the bot. It can either be a saved index file (e.g., `index.pkl`) or a directory of documents (e.g., `./index`). In the case of the directory the index will be automatically created. If no index is specified `bot` will look for `index.pkl` or `./index`\n"
+    "The `index` argument specifies the index to use for the bot. It can either be a saved index file (e.g., `index.pkl`) or a directory of documents (e.g., `./index`). In the case of the directory the index will be automatically created. If no index is specified the `bot` will look for `index.pkl` or `./index`."
    ]
   },
   {
@@ -69,7 +69,7 @@
    "source": [
     "### Changing the bot's prompt\n",
     "\n",
-    "You can change the bots promnpt to customize it to your needs. In the `qna-over-docs` type of bot you will need to pass 2 variables for the `context` (knwoledge searched from the index) and the `question` (the human question).\n"
+    "You can change the bot's promnpt to customize it to your needs. In the `qna-over-docs` type of bot you will need to pass 2 variables for the `context` (knwoledge searched from the index) and the `question` (the human question).\n"
    ]
   },
   {

setup.py

@@ -13,6 +13,9 @@ setup(
         "fastapi",
         "faiss-cpu",
         "pdfminer.six",
+        "gradio",
+        "python-dotenv",
+        "openai",
     ],
     author="Megaklis Vasilakis",
     author_email="megaklis.vasilakis@gmail.com",
@@ -20,6 +23,14 @@ setup(
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     url="https://github.com/momegas/megabots",
+    keywords = [
+    "bot"
+    "qna-bot"
+    "information-retrieval",
+    "chatbot",
+    "question-answering",
+    "prompt-engineering"
+    ]
     license="MIT",
     classifiers=[
         # Choose appropriate classifiers from