Installation
============

Install the core package:

.. code-block:: console

   pip install evidence-fetcher

Configuration
-------------

Create a Brave Search API key and expose it as ``BRAVE_SEARCH_API_KEY``.

Get a Brave Search API key
~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Open the `Brave Search API dashboard`_.
2. Create an account or sign in.
3. Subscribe to a Brave Search API plan.
4. Open the API keys section in the dashboard.
5. Create a new API key and copy it.

Keep the key private. Do not commit it to version control or paste it into
client-side code.

Set the key in your terminal
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The simplest setup is to export the key in the same terminal where you will run
``evidence-fetcher`` or ``evidence-fetcher-ui``:

.. code-block:: console

   export BRAVE_SEARCH_API_KEY="your_api_key_here"

Then run the command from that same terminal:

.. code-block:: console

   evidence-fetcher "retrieval augmented generation evaluation"

Or launch the UI sample:

.. code-block:: console

   evidence-fetcher-ui

This ``export`` lasts only for the current terminal session. If you open a new
terminal window, set ``BRAVE_SEARCH_API_KEY`` again before running the package.

.. _Brave Search API dashboard: https://api-dashboard.search.brave.com/

Optional Streamlit UI
---------------------

Install the optional UI extra to use the browser-based review app:

.. code-block:: console

   pip install "evidence-fetcher[ui]"