search

peterw / Chat-with-Github-Repo

This repository contains two Python scripts that demonstrate how to create a chatbot using Streamlit, OpenAI GPT-3.5-turbo, and Activeloop's Deep Lake.
https://explodinginsights.com/
MIT License
1.14k stars 169 forks source link

Improve setup process #2

Closed dtbuchholz closed 1 year ago

dtbuchholz commented 1 year ago

The current setup process has a number of steps that must happen before getting started that aren't well described in the README or code, including setting up accounts for API keys, app-specific setup, and installing required python dependencies. Also, the setup process could benefit from moving some inline configs to a .env. (and hiding properly via .gitignore).

This PR adds all of these and also updates the README accordingly. It doesn't change the scripts to keep things straightforward, except to use the newly defined env vars.

dtbuchholz commented 1 year ago

@peterw I should have opened an issue but went ahead with some small tweaks to improve the setup process. Lmkwyt. Note that there were some IDE-specific formatting changes in case you have some workspace config preference there.

peterw commented 1 year ago

thanks, merged.