raccoon / README.md
grapplerulrich's picture
Update readme
5aba5c2
# Raccoon
## Installation
It is recommend to use virtual environment using [`venv`](https://docs.python.org/3/library/venv.html).
The fol
- Ceate the virtual envoirnment: `python3 -m venv .venv`
- Activate the virtual envoirnment: `source venv/bin/activate`
- To deactive the virtual envoirnment run `deactivate` within the virtual envoirnment.
- Install the required packages: `.venv/bin/pip install -r requirements.txt`
- `.venv/bin/pip install -e .`
- Add the Google Search API key to `GOOGLE_SEARCH_API_KEY` in `google-search/.env`. For example `GOOGLE_SEARCH_API_KEY=addkeyehere` (TODO) add documentation on how to get the API key.
- To start the interface: `streamlit run google-search/app.py`