ragrep 0.2.1__tar.gz

ragrep-0.2.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ragrep-0.2.1/MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+include LICENSE
+include requirements.txt
+include env.example
+recursive-include examples *.py
+recursive-include docs *.md
+recursive-include tests *.py

ragrep-0.2.1/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: ragrep
+Version: 0.2.1
+Summary: Local semantic code recall with mxbai embeddings and SQLite
+Author-email: RAGrep Team <ragrep@example.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/pierce403/ragrep
+Project-URL: Repository, https://github.com/pierce403/ragrep
+Project-URL: Issues, https://github.com/pierce403/ragrep/issues
+Keywords: semantic-search,embeddings,sqlite,code-search,local
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Indexing
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sentence-transformers>=3.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: build>=1.2.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+# RAGrep
+
+RAGrep is a dead-simple local semantic recall tool for code and text files.
+
+It uses:
+- `mxbai-embed-large` embeddings in-process (no server)
+- a single local SQLite database file: `.ragrep.db`
+
+No ChromaDB. No remote API keys.
+
+## Install
+
+```bash
+pip install ragrep
+```
+
+## Embedding Model Storage
+
+RAGrep downloads the embedding model automatically on first use.
+
+Default model directories:
+- Linux: `~/.config/ragrep/models`
+- macOS: `~/Library/Application Support/ragrep/models`
+- Windows: `%APPDATA%\\ragrep\\models`
+
+Override with:
+- env var: `RAGREP_MODEL_DIR`
+- CLI flag: `--model-dir`
+- Python API: `RAGrep(model_dir="...")`
+
+## GPU Usage
+
+RAGrep can use GPU for embeddings when available.
+
+- Default behavior: `RAGREP_DEVICE=auto` (prefers `cuda`, then `mps`, then `cpu`)
+- Override via env: `RAGREP_DEVICE=cpu|cuda|mps|cuda:0`
+- Override via CLI: `--device ...`
+- Override via Python API: `RAGrep(embedding_device="...")`
+- Note: GPU usage requires a GPU-capable PyTorch build in your environment.
+- Check runtime GPU support: `ragrep --check-gpu` (or `ragrep --check-gpu --json`)
+
+## CLI Usage
+
+Recall is the default command.
+
+```bash
+# Implied recall (auto-indexes when needed)
+ragrep "authentication middleware"
+
+# Explicit recall (same behavior)
+ragrep recall "authentication middleware"
+
+# Build/update index manually
+ragrep index .
+
+# Show stats
+ragrep stats
+
+# Stats alias
+ragrep --stats
+```
+
+When `--path` is omitted, auto-indexing uses the previously indexed root if one exists;
+otherwise it uses the current directory.
+
+Indexing is incremental by default:
+- new files are added
+- modified files are re-embedded
+- removed files are deleted from the index
+
+CLI runs that index files print newly indexed file paths to stdout.
+
+Useful flags:
+
+```bash
+ragrep "query text" --path . --limit 10 --db-path ./.ragrep.db
+ragrep "query text" --model-dir ~/.config/ragrep/models --json
+ragrep "query text" --device auto
+ragrep index . --force
+```
+
+## Python Usage
+
+```python
+from ragrep import RAGrep
+
+rag = RAGrep(
+    db_path="./.ragrep.db",
+    embedding_model="mxbai-embed-large",
+    embedding_device="auto",
+)
+rag.index(".")
+
+result = rag.recall("database transactions", limit=5)
+for match in result["matches"]:
+    print(match["score"], match["metadata"]["source"])
+
+print(rag.stats())
+rag.close()
+```
+
+Library methods:
+- `index(path=".", force=False)`
+- `recall(query, limit=20, path=".", auto_index=True)`
+- `stats()`
+
+Backwards-compatible aliases still available:
+- `RAGSystem` (alias of `RAGrep`)
+- `dump(...)` (alias of `recall(..., auto_index=False)` result list)
+
+## Local Database
+
+RAGrep stores everything in one SQLite file (default `./.ragrep.db`):
+- indexed files and mtimes
+- chunked source text
+- embedding vectors
+- index metadata (model, chunk settings, root path)
+
+## Development
+
+```bash
+pip install -e .[dev]
+python -m unittest discover -s tests -p 'test_*.py'
+python -m build
+twine check dist/*
+```
+
+## License
+
+MIT

ragrep-0.2.1/README.md

@@ -0,0 +1,130 @@
+# RAGrep
+
+RAGrep is a dead-simple local semantic recall tool for code and text files.
+
+It uses:
+- `mxbai-embed-large` embeddings in-process (no server)
+- a single local SQLite database file: `.ragrep.db`
+
+No ChromaDB. No remote API keys.
+
+## Install
+
+```bash
+pip install ragrep
+```
+
+## Embedding Model Storage
+
+RAGrep downloads the embedding model automatically on first use.
+
+Default model directories:
+- Linux: `~/.config/ragrep/models`
+- macOS: `~/Library/Application Support/ragrep/models`
+- Windows: `%APPDATA%\\ragrep\\models`
+
+Override with:
+- env var: `RAGREP_MODEL_DIR`
+- CLI flag: `--model-dir`
+- Python API: `RAGrep(model_dir="...")`
+
+## GPU Usage
+
+RAGrep can use GPU for embeddings when available.
+
+- Default behavior: `RAGREP_DEVICE=auto` (prefers `cuda`, then `mps`, then `cpu`)
+- Override via env: `RAGREP_DEVICE=cpu|cuda|mps|cuda:0`
+- Override via CLI: `--device ...`
+- Override via Python API: `RAGrep(embedding_device="...")`
+- Note: GPU usage requires a GPU-capable PyTorch build in your environment.
+- Check runtime GPU support: `ragrep --check-gpu` (or `ragrep --check-gpu --json`)
+
+## CLI Usage
+
+Recall is the default command.
+
+```bash
+# Implied recall (auto-indexes when needed)
+ragrep "authentication middleware"
+
+# Explicit recall (same behavior)
+ragrep recall "authentication middleware"
+
+# Build/update index manually
+ragrep index .
+
+# Show stats
+ragrep stats
+
+# Stats alias
+ragrep --stats
+```
+
+When `--path` is omitted, auto-indexing uses the previously indexed root if one exists;
+otherwise it uses the current directory.
+
+Indexing is incremental by default:
+- new files are added
+- modified files are re-embedded
+- removed files are deleted from the index
+
+CLI runs that index files print newly indexed file paths to stdout.
+
+Useful flags:
+
+```bash
+ragrep "query text" --path . --limit 10 --db-path ./.ragrep.db
+ragrep "query text" --model-dir ~/.config/ragrep/models --json
+ragrep "query text" --device auto
+ragrep index . --force
+```
+
+## Python Usage
+
+```python
+from ragrep import RAGrep
+
+rag = RAGrep(
+    db_path="./.ragrep.db",
+    embedding_model="mxbai-embed-large",
+    embedding_device="auto",
+)
+rag.index(".")
+
+result = rag.recall("database transactions", limit=5)
+for match in result["matches"]:
+    print(match["score"], match["metadata"]["source"])
+
+print(rag.stats())
+rag.close()
+```
+
+Library methods:
+- `index(path=".", force=False)`
+- `recall(query, limit=20, path=".", auto_index=True)`
+- `stats()`
+
+Backwards-compatible aliases still available:
+- `RAGSystem` (alias of `RAGrep`)
+- `dump(...)` (alias of `recall(..., auto_index=False)` result list)
+
+## Local Database
+
+RAGrep stores everything in one SQLite file (default `./.ragrep.db`):
+- indexed files and mtimes
+- chunked source text
+- embedding vectors
+- index metadata (model, chunk settings, root path)
+
+## Development
+
+```bash
+pip install -e .[dev]
+python -m unittest discover -s tests -p 'test_*.py'
+python -m build
+twine check dist/*
+```
+
+## License
+
+MIT

ragrep-0.2.1/docs/README.md

@@ -0,0 +1,8 @@
+# RAGrep Notes
+
+RAGrep is intentionally minimal:
+- in-process local embeddings (`mxbai-embed-large`)
+- storage in one SQLite file (`.ragrep.db`)
+- API: `index`, `recall`, `stats`
+
+This folder can hold implementation notes and research references as the project evolves.

ragrep-0.2.1/env.example

@@ -0,0 +1,11 @@
+# Embedding configuration
+EMBEDDING_MODEL=mxbai-embed-large
+RAGREP_MODEL_DIR=~/.config/ragrep/models
+RAGREP_DEVICE=auto
+
+# Chunking configuration
+CHUNK_SIZE=1000
+CHUNK_OVERLAP=200
+
+# Database configuration
+RAGREP_DB_PATH=./.ragrep.db

ragrep-0.2.1/examples/basic_usage.py

@@ -0,0 +1,31 @@
+"""Basic usage example for RAGrep."""
+
+from __future__ import annotations
+
+from pathlib import Path
+import sys
+
+# Add src to path when running from repository checkout.
+sys.path.insert(0, str(Path(__file__).parent.parent / "src"))
+
+from ragrep import RAGrep
+
+
+def main() -> None:
+    rag = RAGrep(db_path="./.ragrep.db")
+
+    # Index the current repository.
+    index_result = rag.index(".")
+    print(index_result)
+
+    # Recall relevant chunks.
+    recall_result = rag.recall("semantic search", limit=5)
+    for match in recall_result["matches"]:
+        print(f"{match['score']:.4f} {match['metadata'].get('source')}")
+
+    # Print stats.
+    print(rag.stats())
+
+
+if __name__ == "__main__":
+    main()

ragrep-0.2.1/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ragrep"
+version = "0.2.1"
+description = "Local semantic code recall with mxbai embeddings and SQLite"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+    {name = "RAGrep Team", email = "ragrep@example.com"}
+]
+keywords = ["semantic-search", "embeddings", "sqlite", "code-search", "local"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing :: Indexing",
+]
+
+dependencies = [
+    "sentence-transformers>=3.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "build>=1.2.0",
+    "twine>=5.0.0",
+]
+
+[project.scripts]
+ragrep = "ragrep.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/pierce403/ragrep"
+Repository = "https://github.com/pierce403/ragrep"
+Issues = "https://github.com/pierce403/ragrep/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-dir]
+"" = "src"

ragrep-0.2.1/requirements.txt

@@ -0,0 +1 @@
+sentence-transformers>=3.0.0

ragrep-0.2.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ragrep-0.2.1/setup.py

@@ -0,0 +1,5 @@
+"""Setup shim for tools that still invoke setup.py directly."""
+
+from setuptools import setup
+
+setup()

ragrep-0.2.1/src/ragrep/__init__.py

@@ -0,0 +1,41 @@
+"""RAGrep public package API."""
+
+from __future__ import annotations
+
+__version__ = "0.2.1"
+__author__ = "RAGrep Team"
+
+
+def __getattr__(name: str):
+    if name in {"RAGrep", "RAGSystem"}:
+        from .core.rag_system import RAGrep, RAGSystem
+
+        return RAGrep if name == "RAGrep" else RAGSystem
+
+    if name == "DocumentProcessor":
+        from .core.document_processor import DocumentProcessor
+
+        return DocumentProcessor
+
+    if name == "VectorStore":
+        from .retrieval.vector_store import VectorStore
+
+        return VectorStore
+
+    if name in {"LocalEmbedder", "OllamaEmbedder"}:
+        # Keep OllamaEmbedder alias for backward compatibility.
+        from .retrieval.embeddings import LocalEmbedder
+
+        return LocalEmbedder
+
+    raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
+
+
+__all__ = [
+    "RAGrep",
+    "RAGSystem",
+    "DocumentProcessor",
+    "VectorStore",
+    "LocalEmbedder",
+    "OllamaEmbedder",
+]