feat: implement basic features except facets (#2)

Co-authored-by: Amp <amp@ampcode.com>

Author: ankitml

.github/CODEOWNERS

@@ -1,3 +1,3 @@
 # Order is important. The last matching pattern has the most precedence
 
-* @philippemnoel @rebasedming
+* @philippemnoel @rebasedming @mdashti @ankitml @stuhood

.github/workflows/ci.yml

@@ -10,10 +10,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v5
         with:
           python-version: "3.12"
 
@@ -35,14 +35,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.12", "3.13"]
-        django-version: ["5.0", "5.1"]
+        python-version: ["3.13"]
+        django-version: ["6.0"]
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -57,25 +57,7 @@ jobs:
         run: pytest --cov=paradedb --cov-report=xml
 
       - name: Upload coverage
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v4
         with:
           files: ./coverage.xml
           fail_ci_if_error: false
-
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Set up Python
-        uses: actions/setup-python@v6
-        with:
-          python-version: "3.12"
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -e ".[docs]"
-
-      - name: Build docs
-        run: mkdocs build --strict

.gitignore

@@ -55,4 +55,3 @@ site/
 Thumbs.db
 
 # Snapshots (syrupy)
-__snapshots__/

.markdownlintignore

@@ -0,0 +1 @@
+ROADMAP.md

.pre-commit-config.yaml

@@ -49,4 +49,14 @@ repos:
         additional_dependencies:
           - django-stubs>=5.1
           - django>=5.0
-        args: [--config-file=pyproject.toml]
+        args: [--config-file=pyproject.toml, src/paradedb]
+        pass_filenames: false
+
+  # TODO: Run pytest separately (pre-commit doesn't use venv python)
+  # - repo: local
+  #   hooks:
+  #     - id: pytest
+  #       name: pytest
+  #       entry: python -m pytest
+  #       language: system
+  #       pass_filenames: false

README.md

@@ -39,11 +39,33 @@ class Product(models.Model):
 Product.objects.filter(description=ParadeDB('shoes'))
 ```
 
+## Feature Support
+
+Supported:
+
+- ParadeDB lookup with AND/OR operators (`&&&`, `|||`)
+- `PQ` boolean composition
+- Search expressions: `Phrase`, `Fuzzy`, `Parse`, `Term`, `Regex`
+- Annotations: `Score`, `Snippet`
+- `BM25Index` DDL generation (basic + JSON field keys)
+- `MoreLikeThis` query filter
+- Django ORM integration with `Q`, standard filters, and window functions
+
+Unsupported / pending:
+
+- Faceted search (`.facets()` and `pdb.agg(...)` integration)
+
 ## Documentation
 
-- **Package Documentation**: https://paradedb.github.io/django-paradedb
-- **ParadeDB Official Docs**: https://docs.paradedb.com
-- **ParadeDB Website**: https://paradedb.com
+- **Package Documentation**: <https://paradedb.github.io/django-paradedb>
+- **ParadeDB Official Docs**: <https://docs.paradedb.com>
+- **ParadeDB Website**: <https://paradedb.com>
+
+## Requirements
+
+- Python 3.13+
+- Django 6.0+
+- PostgreSQL with ParadeDB extension
 
 ## Development
 
@@ -60,10 +82,6 @@ pytest
 # Run linting
 ruff check .
 ruff format .
-
-# Build docs locally
-pip install -e ".[docs]"
-mkdocs serve
 ```
 
 ## Support
@@ -87,4 +105,4 @@ We would like to thank the following members of the Django community for their v
 
 ## License
 
-django-paradedb is licensed under the [MIT License](LICENSE).
+django-paradedb is licensed under the [MIT License](LICENSE).