Add quickstart to README.md

README.md

@@ -1,5 +1,40 @@
 # Vegan Recipe Chatbot
 
+![Screenshot of Chatbot initial interface](docs/assets/chatbot_init.png)
+
+## Quickstart
+
+`git clone` the repo  
+
+```sh
+cd lv-recipe-chatbot
+```  
+
+Install Python poetry for dependency management.  
+
+```sh
+poetry install
+```
+
+Put API secrets in .env
+
+```sh
+cp .env.example .env
+# edit .env with your secret key(s). Only OPEN_AI_KEY is required.
+```
+
+One option is to enter the poetry environment.  
+
+```sh
+poetry shell
+```
+
+Then start the Gradio demo.
+
+```sh
+python app.py
+```
+
 ## Useful links
 
 * [Task Matrix (Formerly Visual ChatGPT)](https://github.com/microsoft/TaskMatrix)

chatbot/app.py

@@ -8,7 +8,7 @@ from langchain.prompts.chat import (
     MessagesPlaceholder,
     ChatPromptTemplate,
 )
-from engineer_prompt import init_prompt
+from chatbot.engineer_prompt import init_prompt
 
 # from transformers import (
 #     BlipProcessor,

poetry.lock

@@ -1668,7 +1668,7 @@ python-versions = ">=3.6"
 
 [[package]]
 name = "platformdirs"
-version = "3.3.0"
+version = "3.4.0"
 description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
 category = "main"
 optional = false
@@ -3870,8 +3870,8 @@ pkgutil-resolve-name = [
     {file = "pkgutil_resolve_name-1.3.10.tar.gz", hash = "sha256:357d6c9e6a755653cfd78893817c0853af365dd51ec97f3d358a819373bbd174"},
 ]
 platformdirs = [
-    {file = "platformdirs-3.3.0-py3-none-any.whl", hash = "sha256:ea61fd7b85554beecbbd3e9b37fb26689b227ffae38f73353cbcc1cf8bd01878"},
-    {file = "platformdirs-3.3.0.tar.gz", hash = "sha256:64370d47dc3fca65b4879f89bdead8197e93e05d696d6d1816243ebae8595da5"},
+    {file = "platformdirs-3.4.0-py3-none-any.whl", hash = "sha256:01437886022decaf285d8972f9526397bfae2ac55480ed372ed6d9eca048870a"},
+    {file = "platformdirs-3.4.0.tar.gz", hash = "sha256:a5e1536e5ea4b1c238a1364da17ff2993d5bd28e15600c2c8224008aff6bbcad"},
 ]
 pluggy = [
     {file = "pluggy-1.0.0-py2.py3-none-any.whl", hash = "sha256:74134bbf457f031a36d68416e1509f34bd5ccc019f0bcc952c7b909d06b37bd3"},

pyproject.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 description = "Chatbot for recommending vegan recipes"
 authors = ["Evan Lesmez <evanl@animalequality.org>"]
 readme = "README.md"
-packages = [{ include = "lv_recipe_chatbot" }]
+packages = [{ include = "chatbot" }]
 
 [tool.poetry.dependencies]
 python = "^3.8.1"