ragit 0.7__tar.gz → 0.7.1__tar.gz

ragit-0.7.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.

ragit-0.7.1/PKG-INFO

@@ -0,0 +1,476 @@
+Metadata-Version: 2.4
+Name: ragit
+Version: 0.7.1
+Summary: Automatic RAG Pattern Optimization Engine
+Author: RODMENA LIMITED
+Maintainer-email: RODMENA LIMITED <info@rodmena.co.uk>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rodmena-limited/ragit
+Project-URL: Repository, https://github.com/rodmena-limited/ragit
+Project-URL: Issues, https://github.com/rodmena-limited/ragit/issues
+Keywords: AI,RAG,LLM,GenAI,Optimization,Ollama
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: <3.14,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: pandas>=2.2.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: scikit-learn>=1.5.0
+Requires-Dist: tqdm>=4.66.0
+Provides-Extra: dev
+Requires-Dist: ragit[test]; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: issuedb[web]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Dynamic: license-file
+
+# ragit
+
+A Python toolkit for building Retrieval-Augmented Generation (RAG) applications. Ragit provides document loading, chunking, vector search, and LLM integration out of the box, allowing you to build document Q&A systems and code generators with minimal boilerplate.
+
+## Table of Contents
+
+1. [Installation](#installation)
+2. [Configuration](#configuration)
+3. [Tutorial: Using Ragit](#tutorial-using-ragit)
+   - [Loading Documents](#loading-documents)
+   - [The RAGAssistant Class](#the-ragassistant-class)
+   - [Asking Questions](#asking-questions)
+   - [Generating Code](#generating-code)
+   - [Custom Retrieval](#custom-retrieval)
+4. [Tutorial: Platform Integration](#tutorial-platform-integration)
+   - [Flask Integration](#flask-integration)
+   - [FastAPI Integration](#fastapi-integration)
+   - [Command-Line Tools](#command-line-tools)
+   - [Batch Processing](#batch-processing)
+5. [Advanced: Hyperparameter Optimization](#advanced-hyperparameter-optimization)
+6. [API Reference](#api-reference)
+7. [License](#license)
+
+## Installation
+
+```bash
+pip install ragit
+```
+
+Ragit requires an Ollama-compatible API for embeddings and LLM inference. You can use:
+- A local Ollama instance (https://ollama.ai)
+- A cloud-hosted Ollama API
+- Any OpenAI-compatible API endpoint
+
+## Configuration
+
+Ragit reads configuration from environment variables. Create a `.env` file in your project root:
+
+```bash
+# LLM API (cloud or local)
+OLLAMA_BASE_URL=https://your-ollama-api.com
+OLLAMA_API_KEY=your-api-key
+
+# Embedding API (can be different from LLM)
+OLLAMA_EMBEDDING_URL=http://localhost:11434
+
+# Default models
+RAGIT_DEFAULT_LLM_MODEL=llama3.1:8b
+RAGIT_DEFAULT_EMBEDDING_MODEL=mxbai-embed-large
+```
+
+A common setup is to use a cloud API for LLM inference (faster, more capable models) while running embeddings locally (lower latency, no API costs for indexing).
+
+## Tutorial: Using Ragit
+
+This section covers the core functionality of ragit: loading documents, creating a RAG assistant, and querying your knowledge base.
+
+### Loading Documents
+
+Ragit provides several functions for loading and chunking documents.
+
+**Loading a single file:**
+
+```python
+from ragit import load_text
+
+doc = load_text("docs/api-reference.md")
+print(doc.id)       # "api-reference"
+print(doc.content)  # Full file contents
+```
+
+**Loading a directory:**
+
+```python
+from ragit import load_directory
+
+# Load all markdown files
+docs = load_directory("docs/", "*.md")
+
+# Load recursively
+docs = load_directory("docs/", "**/*.md", recursive=True)
+
+# Load multiple file types
+txt_docs = load_directory("docs/", "*.txt")
+rst_docs = load_directory("docs/", "*.rst")
+all_docs = txt_docs + rst_docs
+```
+
+**Custom chunking:**
+
+For fine-grained control over how documents are split:
+
+```python
+from ragit import chunk_text, chunk_by_separator, chunk_rst_sections
+
+# Fixed-size chunks with overlap
+chunks = chunk_text(
+    text,
+    chunk_size=512,      # Characters per chunk
+    chunk_overlap=50,    # Overlap between chunks
+    doc_id="my-doc"
+)
+
+# Split by paragraph
+chunks = chunk_by_separator(text, separator="\n\n")
+
+# Split RST documents by section headers
+chunks = chunk_rst_sections(rst_content, doc_id="tutorial")
+```
+
+### The RAGAssistant Class
+
+The `RAGAssistant` class is the main interface for RAG operations. It handles document indexing, retrieval, and generation in a single object.
+
+```python
+from ragit import RAGAssistant
+
+# Create from a directory
+assistant = RAGAssistant("docs/")
+
+# Create from a single file
+assistant = RAGAssistant("docs/tutorial.rst")
+
+# Create from Document objects
+from ragit import Document
+
+docs = [
+    Document(id="intro", content="Introduction to the API..."),
+    Document(id="auth", content="Authentication uses JWT tokens..."),
+    Document(id="endpoints", content="Available endpoints: /users, /items..."),
+]
+assistant = RAGAssistant(docs)
+```
+
+**Configuration options:**
+
+```python
+assistant = RAGAssistant(
+    "docs/",
+    embedding_model="mxbai-embed-large",  # Model for embeddings
+    llm_model="llama3.1:70b",             # Model for generation
+    chunk_size=512,                        # Characters per chunk
+    chunk_overlap=50,                      # Overlap between chunks
+)
+```
+
+### Asking Questions
+
+The `ask()` method retrieves relevant context and generates an answer:
+
+```python
+assistant = RAGAssistant("docs/")
+
+answer = assistant.ask("How do I authenticate API requests?")
+print(answer)
+```
+
+**Customizing the query:**
+
+```python
+answer = assistant.ask(
+    "How do I authenticate API requests?",
+    top_k=5,                    # Number of chunks to retrieve
+    temperature=0.3,            # Lower = more focused answers
+    system_prompt="You are a technical documentation assistant. "
+                  "Answer concisely and include code examples."
+)
+```
+
+### Generating Code
+
+The `generate_code()` method is optimized for producing clean, runnable code:
+
+```python
+assistant = RAGAssistant("framework-docs/")
+
+code = assistant.generate_code(
+    "Create a REST API endpoint for user registration",
+    language="python"
+)
+print(code)
+```
+
+The output is clean code without markdown formatting. The assistant uses your documentation as context to generate framework-specific, idiomatic code.
+
+### Custom Retrieval
+
+For advanced use cases, you can access the retrieval and generation steps separately:
+
+```python
+assistant = RAGAssistant("docs/")
+
+# Step 1: Retrieve relevant chunks
+results = assistant.retrieve("authentication", top_k=5)
+for chunk, score in results:
+    print(f"Score: {score:.3f}")
+    print(f"Content: {chunk.content[:200]}...")
+    print()
+
+# Step 2: Get formatted context string
+context = assistant.get_context("authentication", top_k=3)
+
+# Step 3: Generate with custom prompt
+prompt = f"""Based on this documentation:
+
+{context}
+
+Write a Python function that validates a JWT token."""
+
+response = assistant.generate(
+    prompt,
+    system_prompt="You are an expert Python developer.",
+    temperature=0.2
+)
+```
+
+## Tutorial: Platform Integration
+
+This section shows how to integrate ragit into web applications and other platforms.
+
+### Flask Integration
+
+```python
+from flask import Flask, request, jsonify
+from ragit import RAGAssistant
+
+app = Flask(__name__)
+
+# Initialize once at startup
+assistant = RAGAssistant("docs/")
+
+@app.route("/ask", methods=["POST"])
+def ask():
+    data = request.get_json()
+    question = data.get("question", "")
+
+    if not question:
+        return jsonify({"error": "question is required"}), 400
+
+    answer = assistant.ask(question, top_k=3)
+    return jsonify({"answer": answer})
+
+@app.route("/search", methods=["GET"])
+def search():
+    query = request.args.get("q", "")
+    top_k = int(request.args.get("top_k", 5))
+
+    results = assistant.retrieve(query, top_k=top_k)
+    return jsonify({
+        "results": [
+            {"content": chunk.content, "score": score}
+            for chunk, score in results
+        ]
+    })
+
+if __name__ == "__main__":
+    app.run(debug=True)
+```
+
+### FastAPI Integration
+
+```python
+from fastapi import FastAPI, HTTPException
+from pydantic import BaseModel
+from ragit import RAGAssistant
+
+app = FastAPI()
+
+# Initialize once at startup
+assistant = RAGAssistant("docs/")
+
+class Question(BaseModel):
+    question: str
+    top_k: int = 3
+    temperature: float = 0.7
+
+class Answer(BaseModel):
+    answer: str
+
+@app.post("/ask", response_model=Answer)
+async def ask(q: Question):
+    if not q.question.strip():
+        raise HTTPException(status_code=400, detail="question is required")
+
+    answer = assistant.ask(
+        q.question,
+        top_k=q.top_k,
+        temperature=q.temperature
+    )
+    return Answer(answer=answer)
+
+@app.get("/search")
+async def search(q: str, top_k: int = 5):
+    results = assistant.retrieve(q, top_k=top_k)
+    return {
+        "results": [
+            {"content": chunk.content, "score": score}
+            for chunk, score in results
+        ]
+    }
+```
+
+### Command-Line Tools
+
+Build CLI tools using argparse or click:
+
+```python
+#!/usr/bin/env python3
+import argparse
+from ragit import RAGAssistant
+
+def main():
+    parser = argparse.ArgumentParser(description="Query documentation")
+    parser.add_argument("question", help="Question to ask")
+    parser.add_argument("--docs", default="docs/", help="Documentation path")
+    parser.add_argument("--top-k", type=int, default=3, help="Context chunks")
+    args = parser.parse_args()
+
+    assistant = RAGAssistant(args.docs)
+    answer = assistant.ask(args.question, top_k=args.top_k)
+    print(answer)
+
+if __name__ == "__main__":
+    main()
+```
+
+Usage:
+
+```bash
+python ask.py "How do I configure logging?"
+python ask.py "What are the API rate limits?" --docs api-docs/ --top-k 5
+```
+
+### Batch Processing
+
+Process multiple questions or generate reports:
+
+```python
+from ragit import RAGAssistant
+
+assistant = RAGAssistant("docs/")
+
+questions = [
+    "What authentication methods are supported?",
+    "How do I handle errors?",
+    "What are the rate limits?",
+]
+
+# Process questions
+results = {}
+for question in questions:
+    results[question] = assistant.ask(question)
+
+# Generate a report
+with open("qa-report.md", "w") as f:
+    f.write("# Documentation Q&A Report\n\n")
+    for question, answer in results.items():
+        f.write(f"## {question}\n\n")
+        f.write(f"{answer}\n\n")
+```
+
+## Advanced: Hyperparameter Optimization
+
+Ragit includes tools to find the optimal RAG configuration for your specific documents and use case.
+
+```python
+from ragit import RagitExperiment, Document, BenchmarkQuestion
+
+# Your documents
+documents = [
+    Document(id="auth", content="Authentication uses Bearer tokens..."),
+    Document(id="api", content="The API supports GET, POST, PUT, DELETE..."),
+]
+
+# Benchmark questions with expected answers
+benchmark = [
+    BenchmarkQuestion(
+        question="What authentication method does the API use?",
+        ground_truth="The API uses Bearer token authentication."
+    ),
+    BenchmarkQuestion(
+        question="What HTTP methods are supported?",
+        ground_truth="GET, POST, PUT, and DELETE methods are supported."
+    ),
+]
+
+# Run optimization
+experiment = RagitExperiment(documents, benchmark)
+results = experiment.run(max_configs=20)
+
+# Get the best configuration
+best = results[0]
+print(f"Best config: chunk_size={best.config.chunk_size}, "
+      f"chunk_overlap={best.config.chunk_overlap}, "
+      f"top_k={best.config.top_k}")
+print(f"Score: {best.score:.3f}")
+```
+
+The experiment tests different combinations of chunk sizes, overlaps, and retrieval parameters to find what works best for your content.
+
+## API Reference
+
+### Document Loading
+
+| Function | Description |
+|----------|-------------|
+| `load_text(path)` | Load a single text file as a Document |
+| `load_directory(path, pattern, recursive=False)` | Load files matching a glob pattern |
+| `chunk_text(text, chunk_size, chunk_overlap, doc_id)` | Split text into overlapping chunks |
+| `chunk_document(doc, chunk_size, chunk_overlap)` | Split a Document into chunks |
+| `chunk_by_separator(text, separator, doc_id)` | Split text by a delimiter |
+| `chunk_rst_sections(text, doc_id)` | Split RST by section headers |
+
+### RAGAssistant
+
+| Method | Description |
+|--------|-------------|
+| `retrieve(query, top_k=3)` | Return list of (Chunk, score) tuples |
+| `get_context(query, top_k=3)` | Return formatted context string |
+| `generate(prompt, system_prompt, temperature)` | Generate text without retrieval |
+| `ask(question, system_prompt, top_k, temperature)` | Retrieve context and generate answer |
+| `generate_code(request, language, top_k, temperature)` | Generate clean code |
+
+### Properties
+
+| Property | Description |
+|----------|-------------|
+| `assistant.num_documents` | Number of loaded documents |
+| `assistant.num_chunks` | Number of indexed chunks |
+| `assistant.embedding_model` | Current embedding model |
+| `assistant.llm_model` | Current LLM model |
+
+## License
+
+Apache-2.0 - RODMENA LIMITED