setup.md

Setting up Python Dev Env For Local Runs

• Setting up Python Dev Env For Local Runs
  • Step-1: Get the code
  • Step-2: Setup Python Env
    • 2.1 - Option 1 (recommended): using uv
    • 2.2 - Option 2: Using python virtual env
    • 2.3 - Option 3: Setup using Anaconda Environment
    • Optional - Create a Jupyter Kernel
  • Step-3: Activate your Python env
  • Step-4: Get API keys
    • If using Nebius AI
  • If Using Zilliz

Step-1: Get the code

git clone https://github.com/The-AI-Alliance/allycat/

Step-2: Setup Python Env

You can use any of the following to setup local python env.

2.1 - Option 1 (recommended): using uv

1 - Install uv for your machine.

2 - To install all dependencies, run:

cd   allycat/rag-local-milvus-ollama

uv sync

2.2 - Option 2: Using python virtual env

Python 3.11 minimum. 3.12 Recommended

cd   allycat/rag-local-milvus-ollama

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

2.3 - Option 3: Setup using Anaconda Environment

Install Anaconda or conda forge

And then:

cd   allycat/rag-local-milvus-ollama

conda create -n allycat-1  python=3.12
conda activate  allycat-1
pip install -r requirements.txt 

Optional - Create a Jupyter Kernel

# create a ipykernel to run notebooks with vscode / jupyter / etc
source  .venv/bin/activate
python -m ipykernel install --user --name=allycat-1 --display-name "allycat-1"
## Choose this kernel 'allycat-1' within jupyter / vscode

Step-3: Activate your Python env

Don't forget to activate your python env

## if using uv
source .venv/bin/activate

## if using python venv
source  .venv/bin/activate

## If using conda
conda  activate  allycat-1  # what ever the name of the env

Step-4: Get API keys

These keys would be added to .env file

If using Nebius AI

1 - Sign into Nebius Token Factory

2 - Create an API key. See instructions

3 - Add this key to .env file as follows

NEBIUS_API_KEY = "your api key here"

If Using Zilliz

TODO