Skip to main content

🧠 MyRAGProject

A lightweight, developer-friendly Retrieval-Augmented Generation (RAG) engine in Python.

This project allows you to ingest .txt files, generate embeddings, store them in Qdrant (a vector database), and later query them to build intelligent AI applications (like chatbots, document Q&A, etc.).


📦 Features

  • 🔍 Smart chunking of input documents
  • 🤖 Embedding generation via HuggingFace
  • 🧠 Vector storage using Qdrant
  • 💬 Ready for question-answering and search
  • 🚀 Modular and easy to extend

🗂️ Folder Structure

myragproject/ ├── main.py ├── data/ │ └── sample.txt ├── app/ │ ├── config.py │ └── ingest.py ├── raglib/ │ ├── chunking/ │ │ └── smart_chunker.py │ ├── embeddings/ │ │ └── huggingface.py │ └── vector_stores/ │ └── qdrant_store.py

yaml Copy Edit


🔧 Setup Instructions

1. Clone the repository

git clone https://github.com/your-username/myragproject.git
cd myragproject
2. Install dependencies
bash
Copy
Edit
pip install -r requirements.txt
Or manually install:

bash
Copy
Edit
pip install sentence-transformers qdrant-client requests
3. Start Qdrant (vector DB)
bash
Copy
Edit
docker run -p 6333:6333 -v qdrant_data:/qdrant/storage qdrant/qdrant
This ensures persistent vector storage.

4. Add your document
Place a .txt file inside the data/ folder, e.g.:

bash
Copy
Edit
data/sample.txt
🚀 Run the RAG Ingest Pipeline
bash
Copy
Edit
python main.py
It will:

Read the file

Split it into chunks

Generate embeddings

Store in Qdrant with payloads

📖 Example Output
bash
Copy
Edit
📄 Starting ingestion for: data/sample.txt
🧩 Created 4 chunks
🔢 Generated embeddings
✅ Stored 4 points in Qdrant.
✅ Embeddings stored successfully in Qdrant.
🔍 Coming Soon
❓ Ask questions and retrieve top relevant chunks

📚 Support for PDFs and multiple file types

🧪 FastAPI-based chatbot API

🧠 Tech Stack
Python 3.10+

HuggingFace (sentence-transformers)

Qdrant vector store

Docker (for Qdrant server)

🧩 Credits
Built with ❤️ by [Abhishek]

Inspired by modern RAG systems like LangChain, LlamaIndex

📄 License
MIT License

yaml
Copy
Edit

---

## ✅ To Use It Now

Just create a `README.md` file in your root folder and paste the above content.

---

Would you like me to generate:

- `requirements.txt` for you?
- Add FastAPI interface?
- Publish this to GitHub with a badge?

Let’s make this production-ready 🚀

Metadata

Release files for raggenius 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for raggenius 0.2.1
File Size Uploaded Provenance Actions
raggenius-0.2.1.tar.gz 6.4 kB Without provenance Details for raggenius-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for raggenius 0.2.1
File Interpreter ABI Platform Actions
raggenius-0.2.1-py3-none-any.whl Python 3 none any Details for raggenius-0.2.1-py3-none-any.whl

Total release size: 14.1 kB

Release files / raggenius-0.2.1.tar.gz

Download URL raggenius-0.2.1.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
c6224aba3881b7eeaefc3856861ece436ccaf535c4ba3c26a2868f5ccceb0d99
BLAKE2b-256 checksum
How to use checksums
240cb34ece04f8b491ae07f4cda2e42b9bdeeb22e6844bc4f0f74d7f74947116
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.0

Release files / raggenius-0.2.1-py3-none-any.whl

Download URL raggenius-0.2.1-py3-none-any.whl
Size 7.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
10792ebd43e2659a6b98d1755b61d2b2a8b352b1796933bea9ce5aa21ab5ad48
BLAKE2b-256 checksum
How to use checksums
012ee3ef4314bf2bcbd9d410b9073e3e0c6cafba996418c0fb42d94bd227e9d8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.0

Security for raggenius 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page