Skip to content

Commit ce4f863

Browse files
committed
chore: Changed name from ragkit to minirag
1 parent c581050 commit ce4f863

36 files changed

Lines changed: 81 additions & 93 deletions

.env.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ OPENAI_API_KEY=sk-...
1616
# OLLAMA_BASE_URL=http://localhost:11434
1717

1818
# Paths (optional — default: ./data and ./chroma_db in cwd)
19-
# RAGKIT_DATA_DIR=./data
20-
# RAGKIT_CHROMA_DIR=./chroma_db
19+
# MINIRAG_DATA_DIR=./data
20+
# MINIRAG_CHROMA_DIR=./chroma_db
2121

2222
# Optional overrides
2323
# EMBEDDING_MODEL=text-embedding-3-small

CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Changelog
22

3-
All notable changes to **RAGKit** (`ragkit` on PyPI) are documented here.
3+
All notable changes to **MiniRAG** (`minirag` on PyPI) are documented here.
44

55
## [0.1.0] - 2026-07-05
66

77
### Added
8-
- Production `src/ragkit/` package layout (PyPI-ready)
8+
- Production `src/minirag/` package layout (PyPI-ready)
99
- High-level `RAG` client with multi-provider LLM support (OpenAI, Azure, Anthropic, Gemini, Ollama)
1010
- Full RAG pipeline: ingest → query rewrite → multi-query retrieval → rerank → generate → guardrails → eval/retry
11-
- CLI: `ragkit ingest` / `ragkit query`
11+
- CLI: `minirag ingest` / `minirag query`
1212
- Optional extras: `[rerank]`, `[anthropic]`, `[gemini]`, `[all]`
1313

1414
### Changed
15-
- Renamed public package from `complete-basic-rag`**`ragkit`**
16-
- Moved all implementation under installable `src/ragkit/`
17-
- Data/chroma paths default to cwd (`RAGKIT_DATA_DIR`, `RAGKIT_CHROMA_DIR`)
18-
- Reranking moved to optional dependency (`pip install ragkit[rerank]`)
15+
- Renamed public package from `complete-basic-rag`**`minirag`**
16+
- Moved all implementation under installable `src/minirag/`
17+
- Data/chroma paths default to cwd (`MINIRAG_DATA_DIR`, `MINIRAG_CHROMA_DIR`)
18+
- Reranking moved to optional dependency (`pip install minirag[rerank]`)
1919

2020
[0.1.0]: https://github.com/RaghavOG/rag-python/releases/tag/v0.1.0

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# RAGKit
1+
# MiniRAG
22

33
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
55
[![GitHub](https://img.shields.io/badge/GitHub-RaghavOG%2Frag--python-blue)](https://github.com/RaghavOG/rag-python)
66

7-
**RAGKit** is a production-oriented Python library for **Retrieval-Augmented Generation (RAG)**.
7+
**MiniRAG** is a lightweight, production-oriented Python library for **Retrieval-Augmented Generation (RAG)**.
88

99
Ingest your documents, ask questions, get grounded answers — with query rewriting, multi-query retrieval, reranking, guardrails, and multi-LLM support.
1010

@@ -26,7 +26,7 @@ Ingest your documents, ask questions, get grounded answers — with query rewrit
2626
## Install
2727

2828
```bash
29-
pip install ragkit
29+
pip install minirag
3030
# or from source
3131
pip install -e .
3232
# with reranking + extra providers
@@ -38,7 +38,7 @@ pip install -e ".[rerank,anthropic,gemini,all]"
3838
## Quickstart
3939

4040
```python
41-
from ragkit import RAG
41+
from minirag import RAG
4242

4343
rag = RAG(
4444
llm_provider="openai",
@@ -56,8 +56,8 @@ print(answer.text)
5656

5757
```bash
5858
export OPENAI_API_KEY=sk-...
59-
ragkit ingest ./data --reindex
60-
ragkit query "How many days of annual leave?" -v
59+
minirag ingest ./data --reindex
60+
minirag query "How many days of annual leave?" -v
6161
```
6262

6363
---
@@ -73,8 +73,8 @@ ragkit query "How many days of annual leave?" -v
7373
| `AZURE_OPENAI_API_KEY` | For Azure | Azure OpenAI |
7474
| `OPENAI_API_VERSION` | Azure | Default `2023-09-01-preview` |
7575
| `OLLAMA_BASE_URL` | Ollama | Default `http://localhost:11434` |
76-
| `RAGKIT_DATA_DIR` | Optional | Default `./data` |
77-
| `RAGKIT_CHROMA_DIR` | Optional | Default `./chroma_db` |
76+
| `MINIRAG_DATA_DIR` | Optional | Default `./data` |
77+
| `MINIRAG_CHROMA_DIR` | Optional | Default `./chroma_db` |
7878

7979
See [`.env.example`](.env.example) for all tuning options.
8080

@@ -84,7 +84,7 @@ See [`.env.example`](.env.example) for all tuning options.
8484

8585
```text
8686
.
87-
├── src/ragkit/ # Installable package (PyPI)
87+
├── src/minirag/ # Installable package (PyPI)
8888
│ ├── client.py # High-level RAG API
8989
│ ├── rag_pipeline.py # Full pipeline
9090
│ └── providers/ # OpenAI, Azure, Anthropic, Gemini, Ollama

docs/PROVIDERS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
## Providers
22

3-
RAGKit separates **LLM provider** (generation, rewriting, guardrails) from **embedding provider** (retrieval).
3+
MiniRAG separates **LLM provider** (generation, rewriting, guardrails) from **embedding provider** (retrieval).
44

55
### LLM providers
66

77
| Provider | `llm_provider=` | Env |
88
|----------|-----------------|-----|
99
| OpenAI | `openai` | `OPENAI_API_KEY` |
1010
| Azure OpenAI | `azure_openai` | `AZURE_OPENAI_ENDPOINT`, `AZURE_OPENAI_API_KEY` |
11-
| Anthropic | `anthropic` | `ANTHROPIC_API_KEY` + `pip install ragkit[anthropic]` |
12-
| Gemini | `gemini` | `GEMINI_API_KEY` + `pip install ragkit[gemini]` |
11+
| Anthropic | `anthropic` | `ANTHROPIC_API_KEY` + `pip install minirag[anthropic]` |
12+
| Gemini | `gemini` | `GEMINI_API_KEY` + `pip install minirag[gemini]` |
1313
| Ollama | `ollama` | Ollama running locally |
1414

1515
### Embedding providers
@@ -25,7 +25,7 @@ Anthropic and Gemini are **LLM-only** in this version — pair them with OpenAI
2525
### Reranking (optional)
2626

2727
```bash
28-
pip install ragkit[rerank]
28+
pip install minirag[rerank]
2929
```
3030

3131
Uses `sentence-transformers` cross-encoder (`BAAI/bge-reranker-base` by default).

docs/USAGE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
### Python API
44

55
```python
6-
from ragkit import RAG
6+
from minirag import RAG
77

88
rag = RAG(
99
llm_provider="openai",
@@ -23,8 +23,8 @@ print(ans.evaluation) # faithfulness / relevance scores
2323

2424
```bash
2525
pip install -e .
26-
ragkit ingest ./data --reindex
27-
ragkit query "How many days of annual leave?" -v
26+
minirag ingest ./data --reindex
27+
minirag query "How many days of annual leave?" -v
2828
```
2929

3030
### Local development

examples/ollama_local.py

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
1-
from ragkit import RAG
2-
3-
4-
def main():
5-
# Ensure Ollama is running and models are pulled:
6-
# ollama pull llama3.1
7-
# ollama pull mxbai-embed-large
8-
rag = RAG(
9-
llm_provider="ollama",
10-
llm_model="llama3.1",
11-
embedding_provider="ollama",
12-
embedding_model="mxbai-embed-large",
13-
)
14-
rag.ingest(["./data"], reindex=True)
15-
ans = rag.query("How many days of annual leave?")
16-
print(ans.text)
17-
18-
19-
if __name__ == "__main__":
20-
main()
1+
from minirag import RAG
2+
3+
rag = RAG(
4+
llm_provider="ollama",
5+
llm_model="llama3.1",
6+
embedding_provider="ollama",
7+
embedding_model="mxbai-embed-large",
8+
)
9+
10+
rag.ingest(["./data"], reindex=True)
11+
answer = rag.query("How many days of annual leave?")
12+
print(answer.text)

examples/openai_basic.py

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
from ragkit import RAG
2-
3-
4-
def main():
5-
rag = RAG(
6-
llm_provider="openai",
7-
llm_model="gpt-4o-mini",
8-
embedding_provider="openai",
9-
embedding_model="text-embedding-3-small",
10-
)
11-
rag.ingest(["./data"], reindex=True)
12-
ans = rag.query("How many days of annual leave?")
13-
print(ans.text)
14-
15-
16-
if __name__ == "__main__":
17-
main()
1+
from minirag import RAG
2+
3+
rag = RAG(
4+
llm_provider="openai",
5+
llm_model="gpt-4o-mini",
6+
embedding_provider="openai",
7+
embedding_model="text-embedding-3-small",
8+
)
9+
10+
rag.ingest(["./data"], reindex=True)
11+
answer = rag.query("How many days of annual leave?")
12+
print(answer.text)

main.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
"""Thin CLI wrapper for local development (prefer: ragkit CLI after pip install -e .)."""
1+
"""Thin CLI wrapper for local development (prefer: minirag CLI after pip install -e .)."""
22
import argparse
33
from pathlib import Path
44

5-
from ragkit.config import DATA_DIR, CHUNK_STRATEGY
6-
from ragkit import ingest, query, RAGResponse
5+
from minirag.config import DATA_DIR, CHUNK_STRATEGY
6+
from minirag import ingest, query, RAGResponse
77

88

99
def cmd_ingest(args):
@@ -34,7 +34,7 @@ def cmd_query(args):
3434

3535

3636
def cmd_chat(args):
37-
print("RAGKit chat. Type your question. 'quit' or 'exit' to stop.")
37+
print("MiniRAG chat. Type your question. 'quit' or 'exit' to stop.")
3838
while True:
3939
try:
4040
q = input("\nYou: ").strip()
@@ -49,7 +49,7 @@ def cmd_chat(args):
4949

5050

5151
def main():
52-
parser = argparse.ArgumentParser(description="RAGKit (local dev CLI)")
52+
parser = argparse.ArgumentParser(description="MiniRAG (local dev CLI)")
5353
sub = parser.add_subparsers(dest="command", required=True)
5454

5555
ing = sub.add_parser("ingest", help="Load documents, clean, chunk, embed, store")

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ requires = ["setuptools>=61.0", "wheel"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "ragkit"
6+
name = "minirag"
77
version = "0.1.0"
8-
description = "Production-grade modular RAG: multi-LLM, query rewriting, reranking, guardrails, and evaluation."
8+
description = "Lightweight production-grade RAG for Python: multi-LLM, query rewriting, reranking, guardrails, and evaluation."
99
readme = "README.md"
1010
license = { text = "MIT" }
1111
requires-python = ">=3.10"
1212
authors = [
1313
{ name = "Raghav Singla", email = "raghavog@users.noreply.github.com" },
1414
]
15-
keywords = ["rag", "llm", "embeddings", "chromadb", "openai", "retrieval-augmented-generation"]
15+
keywords = ["rag", "llm", "embeddings", "chromadb", "openai", "minirag", "retrieval-augmented-generation"]
1616
classifiers = [
1717
"Development Status :: 4 - Beta",
1818
"Intended Audience :: Developers",
@@ -41,10 +41,10 @@ rerank = ["sentence-transformers>=2.2.0", "torch>=2.0.0"]
4141
anthropic = ["anthropic>=0.20.0"]
4242
gemini = ["google-genai>=0.3.0"]
4343
dev = ["pytest>=7.0", "ruff>=0.1.0", "build", "twine"]
44-
all = ["ragkit[rerank,anthropic,gemini]"]
44+
all = ["minirag[rerank,anthropic,gemini]"]
4545

4646
[project.scripts]
47-
ragkit = "ragkit.cli:main"
47+
minirag = "minirag.cli:main"
4848

4949
[project.urls]
5050
Homepage = "https://github.com/RaghavOG/rag-python"
@@ -56,7 +56,7 @@ Issues = "https://github.com/RaghavOG/rag-python/issues"
5656
where = ["src"]
5757

5858
[tool.setuptools.package-data]
59-
ragkit = ["py.typed"]
59+
minirag = ["py.typed"]
6060

6161
[tool.pytest.ini_options]
6262
testpaths = ["tests"]
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
"""RAGKit — production-grade modular RAG for Python.
1+
"""MiniRAGlightweight production-grade RAG for Python.
22
33
Quick start::
44
5-
from ragkit import RAG
5+
from minirag import RAG
66
77
rag = RAG(llm_model="gpt-4o-mini")
88
rag.ingest(["./docs"], reindex=True)

0 commit comments

Comments
 (0)