README.md

# 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 .`
 - [Create a custom search engine in Google](https://programmablesearchengine.google.com/controlpanel/all).
 - Create a API for the custom search engine.
 - Add the custom search engine key and PI key to `.streamlit/secrets.toml`.
```toml
google_search_api_key = "api-key"
google_search_engine_id = "search-engine-id"
```
 - To start the interface: `streamlit run app.py`