ParadeDB Django Integration

Features

• BM25 full-text search
• HNSW vector similarity search
• Django ORM integration

Quick Start

1. Install:

   git clone https://github.com/Dhruv-Bajaj-code/django-paradedb.git
   cd paradedb-django
   pip install .
   

2. Add to settings.py:

   INSTALLED_APPS = [
       'paradedb',
       # ...
   ]
   

3. Create extension:

   python manage.py setup_paradedb
   

4. Create models with custom indexes:

   from paradedb import BM25Index
   
   class Document(models.Model):
       content = models.TextField()
       
       class Meta:
           indexes = [BM25Index(fields=['content'])]
   

5. Query using custom lookups:

   Document.objects.filter(content__bm25='search term')
   
   

---

Key Features

1. Full ORM Integration: Use Django's standard query syntax
2. Type Safety: Automatic parameter escaping
3. Index Management: Native Django migration support
4. Performance: Direct translation to ParadeDB's native operators
5. Extensibility: Add new index types/lookups as needed

This implementation provides a production-ready integration of ParadeDB's features while maintaining Django's ORM patterns. Users can install it via pip and start using ParadeDB features with minimal configuration.