ragfallback 0.1.0__tar.gz

ragfallback-0.1.0/INSTALL_AND_RUN.md

@@ -0,0 +1,102 @@
+# Install and Run ragfallback
+
+## Quick Start
+
+```bash
+# 1. Install library
+pip install -e .
+
+# 2. Verify installation
+python verify_library.py
+
+# 3. Run all examples
+python run_all_examples.py
+```
+
+## Installation
+
+### Basic Installation
+
+```bash
+pip install -e .
+```
+
+### With Optional Dependencies
+
+```bash
+# Open-source components (recommended)
+pip install -e .[sentence-transformers,faiss]
+
+# Or install manually
+pip install sentence-transformers faiss-cpu huggingface-hub
+```
+
+## Verification
+
+```bash
+# Verify library installation and core functionality
+python verify_library.py
+```
+
+**Expected:** All 6 tests pass ✅
+
+## Run Examples
+
+### Run All Examples
+
+```bash
+python run_all_examples.py
+```
+
+### Run Individual Examples
+
+**Simple Examples:**
+
+```bash
+python examples/python_docs_example.py
+python examples/tech_support_example.py
+```
+
+**Advanced Examples:**
+
+```bash
+python examples/legal_document_analysis.py
+python examples/medical_research_synthesis.py
+python examples/financial_risk_analysis.py
+python examples/multi_domain_synthesis.py
+python examples/complete_example.py
+```
+
+## Run Tests
+
+```bash
+# Install test dependencies
+pip install -r requirements-dev.txt
+
+# Run unit tests
+pytest tests/ -v
+
+# Run with coverage
+pytest --cov=ragfallback --cov-report=html
+```
+
+## Library Structure
+
+```
+ragfallback/
+├── ragfallback/          # Core library
+├── examples/            # 11 example files
+├── tests/               # Unit tests
+├── verify_library.py    # Installation verification
+├── run_all_examples.py  # Run all examples
+├── pyproject.toml       # Package config
+├── requirements-dev.txt # Dev dependencies
+└── README.md           # Documentation
+```
+
+## Success Criteria
+
+✅ `python verify_library.py` passes all tests  
+✅ `pytest tests/` passes all unit tests  
+✅ At least 3 examples run successfully  
+✅ Library can be imported: `from ragfallback import AdaptiveRAGRetriever`

ragfallback-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Irfan Ali
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ragfallback-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include README.md
+include LICENSE
+include INSTALL_AND_RUN.md
+include requirements-dev.txt
+include pyproject.toml
+include pytest.ini
+recursive-include ragfallback *.py py.typed
+recursive-include examples *.py
+recursive-include tests *.py
+