Initial version released

.github/workflows/pytest.yml

@@ -0,0 +1,25 @@
+name: Run Pytest
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.10"
+
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        pip3 install -r requirements.txt  
+
+    - name: Run Pytest
+      run: |
+        python3 -m pytest bestrag/tests/test_best_rag.py

.gitignore

@@ -0,0 +1,93 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+.coverage
+.coverage.*
+.cache
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+.devcontainer/
+.vscode/
+
+# SageMath parsed files
+*.sage.py
+test.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+build/
+dist/
+bestrag.egg-info
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contribution Guidelines
+
+Please ensure your pull request adheres to the following guidelines:
+
+- Check your syntax and grammar.
+- Follow best practices
+
+Thank you for your suggestions!

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Abdul Samad Siddiqui
+
+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.

README.md

@@ -0,0 +1,57 @@
+
+![Supported python versions](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
+[![PEP8](https://img.shields.io/badge/code%20style-pep8-black.svg)](https://www.python.org/dev/peps/pep-0008/)
+[![License](https://img.shields.io/badge/License-MIT%202.0-blue.svg)](LICENSE)
+[![Run Pytest](https://github.com/samadpls/BestRAG/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/samadpls/BestRAG/actions/workflows/pytest.yml)
+<img src='https://img.shields.io/github/stars/samadpls/BestRAG?color=red&label=stars&logoColor=black&style=social'>
+
+Welcome to **BestRAG**! This Python library enables you to efficiently store and retrieve embeddings using a hybrid Retrieval-Augmented Generation (RAG) approach. It combines dense, sparse, and late interaction embeddings to provide a robust solution for handling large datasets.
+
+## 🚀 Installation
+
+To install **BestRAG**, simply run:
+
+```bash
+pip install bestrag
+```
+
+## 📦 Usage
+
+Here’s how you can use **BestRAG** in your projects:
+
+```python
+from bestrag import BestRAG
+
+rag = BestRAG(
+    url="https://YOUR_QDRANT_URL", 
+    api_key="YOUR_API_KEY", 
+    collection_name="YOUR_COLLECTION_NAME"
+)
+
+# Store embeddings from a PDF
+rag.store_pdf_embeddings("your_pdf_file.pdf")
+
+# Search using a query
+results = rag.search(query="your search query", limit=10)
+print(results)
+```
+
+> **Note**: To generate your API key and endpoint, visit [Qdrant](https://qdrant.tech/).
+
+## ✨ Features
+
+- **Hybrid RAG**: Utilizes dense, sparse, and late interaction embeddings for enhanced performance.
+- **Easy Integration**: Simple API for storing and searching embeddings.
+- **PDF Support**: Directly store embeddings from PDF documents.
+
+## 🤝 Contributing
+
+Feel free to contribute to **BestRAG**! Whether it’s reporting bugs, suggesting features, or submitting pull requests, your contributions are welcome. 
+
+## 📝 License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+Created by [samadpls](https://github.com/samadpls) 🎉

bestrag/__init__.py

@@ -0,0 +1 @@
+from .best_rag import BestRAG