Getting Started¶
Welcome to Pygrad! This guide will help you get up and running quickly.
What is Pygrad?¶
Pygrad is a Python library that builds searchable knowledge graphs from Python repository documentation using Graph RAG (Retrieval-Augmented Generation) technology.
It allows you to:
- Index any Python repository from GitHub
- Search the indexed documentation using natural language
- Get answers with relevant code examples and API references
Prerequisites¶
- Python 3.10 or higher
- Git (for cloning repositories)
- An LLM provider (Ollama recommended for local usage, or OpenAI)
Quick Links¶
Installation¶
Step-by-step installation guide for all platforms.
Quick Start¶
Get started in 5 minutes with a simple example.