diff --git a/github-rag/README.md b/github-rag/README.md index 24f6ee6e9..772b7c05c 100644 --- a/github-rag/README.md +++ b/github-rag/README.md @@ -7,9 +7,22 @@ This project leverages GitIngest to parse a GitHub repo in markdown format and t ## Installation and setup **Install Dependencies**: - Ensure you have Python 3.11 or later installed. + Ensure you have Python 3.9 or later installed (tested with Python 3.11.9). + + **Option 1: Using requirements.txt (Recommended)** ```bash - pip install gitingest llama-index llama-index-llms-ollama llama-index-agent-openai llama-index-llms-openai --upgrade --quiet + pip install -r requirements.txt + ``` + + **Option 2: Manual installation** + ```bash + pip install gitingest llama-index llama-index-llms-ollama llama-index-llms-openai llama-index-agent-openai llama-index-embeddings-huggingface streamlit pandas python-dotenv huggingface-hub + ``` + +**Environment Setup**: + For OpenAI integration, create a `.env` file in the project directory: + ``` + OPENAI_API_KEY=your_openai_api_key_here ``` **Running**: diff --git a/github-rag/requirements.txt b/github-rag/requirements.txt new file mode 100644 index 000000000..e55295373 --- /dev/null +++ b/github-rag/requirements.txt @@ -0,0 +1,18 @@ +# GitHub RAG Application Requirements +# Supports Python >=3.9, <4.0 + +# Core dependencies +gitingest +streamlit +python-dotenv +pandas + +# LlamaIndex core and integrations - using compatible versions +llama-index +llama-index-llms-ollama +llama-index-llms-openai +llama-index-agent-openai +llama-index-embeddings-huggingface + +# Additional dependencies for local model support +huggingface-hub \ No newline at end of file