diff --git a/CHANGELOG.md b/CHANGELOG.md index ef007b1..65c2ab8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,4 +10,4 @@ - Documented architecture, limitations, and quickstart workflow with new README badges. ## 0.1.0 - 2024-05-01 -- Initial release of raglite with SQLite-backed RAG pipeline, Typer CLI, FastAPI server, and demo corpus. +- Initial release of raglite-sqlite with SQLite-backed RAG pipeline, Typer CLI, FastAPI server, and demo corpus. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1783136..b46633a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to raglite +# Contributing to raglite-sqlite -Thank you for helping improve raglite! The project aims to provide a practical local-first RAG stack powered by SQLite. +Thank you for helping improve raglite-sqlite! The project aims to provide a practical local-first RAG stack powered by SQLite. ## Getting started diff --git a/README.md b/README.md index c982194..ebbd3c4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# raglite-SQLite + +# raglite-sqlite [![CI](https://github.com/mmprotest/raglite-sqlite/actions/workflows/ci.yml/badge.svg)](https://github.com/mmprotest/raglite-sqlite/actions/workflows/ci.yml) ![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg) ![Python: 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg) -[![PyPI](https://img.shields.io/pypi/v/raglite-sqlite.svg)](https://pypi.org/project/raglite-SQLite/) + +[![PyPI](https://img.shields.io/pypi/v/raglite-sqlite.svg)](https://pypi.org/project/raglite-sqlite/) Local-first retrieval augmented generation toolkit built on SQLite. Raglite bundles ingestion, chunking, hybrid BM25/vector search, Typer CLI workflows, and a FastAPI @@ -24,7 +26,7 @@ _On Windows use `\.venv\Scripts\activate` for step two._ ## Installation -Raglite is published as [`raglite-SQLite` on PyPI](https://pypi.org/project/raglite-SQLite/). Install the +Raglite is published as [`raglite-sqlite` on PyPI](https://pypi.org/project/raglite-sqlite/). Install the core toolkit with: ```bash diff --git a/pyproject.toml b/pyproject.toml index 73f13d9..cc01823 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=64", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "raglite" +name = "raglite-sqlite" version = "0.2.0" description = "Local-first RAG toolkit backed by a single SQLite database" readme = "README.md" diff --git a/scripts/eval_small.py b/scripts/eval_small.py index 095290f..b49fb54 100755 --- a/scripts/eval_small.py +++ b/scripts/eval_small.py @@ -170,7 +170,7 @@ def main(argv: Sequence[str] | None = None) -> int: if rerank_available(): metrics.append(evaluate_variant(api, cases, alpha=args.alpha, rerank=True)) else: - print("(Hybrid+Rerank skipped: install raglite[rerank] to enable)") + print("(Hybrid+Rerank skipped: install raglite-sqlite[rerank] to enable)") print_table(metrics) if tmp_dir is not None: diff --git a/src/raglite/__init__.py b/src/raglite/__init__.py index 9103b82..4213bb2 100644 --- a/src/raglite/__init__.py +++ b/src/raglite/__init__.py @@ -6,7 +6,7 @@ from .config import RagliteConfig try: - __version__ = importlib_metadata.version("raglite") + __version__ = importlib_metadata.version("raglite-sqlite") except importlib_metadata.PackageNotFoundError: # pragma: no cover - fallback for dev installs __version__ = "0.0.0" diff --git a/src/raglite/server/app.py b/src/raglite/server/app.py index a3b49ab..32afd07 100644 --- a/src/raglite/server/app.py +++ b/src/raglite/server/app.py @@ -10,7 +10,7 @@ from fastapi import FastAPI, HTTPException from pydantic import BaseModel except Exception as exc: # pragma: no cover - optional dependency - raise RuntimeError("Install raglite[server] to use the FastAPI app") from exc + raise RuntimeError("Install raglite-sqlite[server] to use the FastAPI app") from exc from ..api import RagliteAPI from ..config import RagliteConfig