meilisearch-python-sdk 3.4.0__tar.gz → 3.5.1__tar.gz

meilisearch_python_sdk-3.5.1/.github/release-draft-template.yaml

@@ -0,0 +1,28 @@
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
+exclude-labels:
+  - "dependencies"
+  - "skip-changelog"
+version-resolver:
+  major:
+    labels:
+      - "breaking-change"
+  minor:
+    labels:
+      - "enhancement"
+      - "feature"
+  default: patch
+categories:
+  - title: "⚠️ Breaking changes"
+    label: "breaking-change"
+  - title: "Features"
+    labels:
+      - "feature"
+      - "enhancement"
+  - title: "Bug Fixes"
+    labels: "bug"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+template: |
+  ## Changes
+
+  $CHANGES

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/.github/workflows/nightly_testing.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Install Dependencies
         run: |
           just install
-          uv add --dev pytest-randomly
+          uv pip install pytest-randomly
       - name: Test with pytest in random order
         run: just test-ci
       - name: Minimize uv cache

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/.github/workflows/testing.yaml

@@ -40,7 +40,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13.0-beta.4"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -76,7 +76,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13.0-beta.4" ]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -98,16 +98,20 @@ jobs:
             uv-${{ runner.os }}
       - name: Install Dependencies
         run: just install
-      - name: Test with pytest
+      - name: Install truststore
+        if: ${{ ! startsWith(matrix.python-version, '3.9') }}
+        run: uv pip install truststore
+      - name: Install ssl requirements
         run: |
-          sudo apt-get update && \
-          sudo apt-get install -y libnss3-tools build-essential gcc && \
-          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && \
-          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" && \
-          brew install mkcert && \
-          mkcert -install && \
-          mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1 && \
-          just test-parallel-ci-http2
+          sudo apt-get update
+          sudo apt-get install -y libnss3-tools build-essential gcc
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+          brew install mkcert
+          mkcert -install
+          mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1
+      - name: Test with pytest
+        run: just test-parallel-ci-http2
       - name: Upload coverage
         uses: codecov/codecov-action@v4
         with:
@@ -120,7 +124,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13.0-beta.4"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -153,49 +157,69 @@ jobs:
         run: uv cache prune --ci
 
   no-parallel-testing-http2:
-      strategy:
-        fail-fast: false
-        matrix:
-          python-version: ["3.9", "3.10", "3.11", "3.12", "3.13.0-beta.4"]
-      runs-on: ubuntu-latest
-      steps:
-        - uses: actions/checkout@v4
-        - name: install Just
-          uses: taiki-e/install-action@just
-        - name: Install uv
-          run: curl -LsSf https://astral.sh/uv/install.sh | sh
-        - name: Set up Python ${{ matrix.python-version }}
-          uses: actions/setup-python@v5
-          with:
-            python-version: ${{ matrix.python-version }}
-        - name: Restore uv cache
-          uses: actions/cache@v4
-          with:
-            path: ${{ env.UV_CACHE_DIR }}
-            key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            restore-keys: |
-              uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-              uv-${{ runner.os }}
-        - name: Install Dependencies
-          run: just install
-        - name: Test with pytest
-          run: |
-            sudo apt-get update && \
-            sudo apt-get install -y libnss3-tools build-essential gcc && \
-            /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && \
-            eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" && \
-            brew install mkcert && \
-            mkcert -install && \
-            mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1 && \
-            just test-no-parallel-ci-http2
-        - name: Upload coverage
-          uses: codecov/codecov-action@v4
-          with:
-            token: ${{ secrets.CODECOV_TOKEN }}
-            fail_ci_if_error: true
-        - name: Minimize uv cache
-          run: uv cache prune --ci
-
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Install Dependencies
+        run: just install
+      - name: Install truststore
+        if: ${{ ! startsWith(matrix.python-version, '3.9') }}
+        run: uv pip install truststore
+      - name: Install ssl requirements
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libnss3-tools build-essential gcc
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+          brew install mkcert
+          mkcert -install
+          mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1
+      - name: Test with pytest
+        run: just test-no-parallel-ci-http2
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+  example-testing:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Test with pytest
+        run: just test-examples-ci
 
   docs:
     runs-on: ubuntu-latest

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-toml
@@ -14,7 +14,7 @@ repos:
       - id: mypy
         additional_dependencies: [pydantic, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.3
+    rev: v0.6.9
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: meilisearch-python-sdk
-Version: 3.4.0
+Version: 3.5.1
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk
@@ -37,6 +37,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Requires-Dist: aiofiles>=0.7

meilisearch_python_sdk-3.5.1/codecov.yml

@@ -0,0 +1,6 @@
+codecov:
+  notify:
+    after_n_builds: 10
+
+comment:
+  after_n_builds: 10

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/examples/add_documents_in_batches.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from meilisearch_python_sdk import Client

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/examples/async_add_documents_decorator.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import asyncio
 import json
+from pathlib import Path
 from typing import Any
 
 import aiofiles
@@ -14,8 +15,10 @@ from meilisearch_python_sdk.decorators import ConnectionInfo, async_add_document
     index_name="movies",
     connection_info=ConnectionInfo(url="http://127.0.0.1:7700", api_key="masterKey"),
 )
-async def load_documents() -> list[dict[str, Any]]:
-    async with aiofiles.open("../datasets/small_movies.json", "r") as f:
+async def load_documents(
+    file_path: Path | str = "../datasets/small_movies.json",
+) -> list[dict[str, Any]]:
+    async with aiofiles.open(file_path) as f:
         data = await f.read()
         documents = json.loads(data)
 

meilisearch_python_sdk-3.5.1/examples/async_add_documents_in_batches.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+import asyncio
+import json
+from pathlib import Path
+
+import aiofiles
+
+from meilisearch_python_sdk import AsyncClient, AsyncIndex
+from meilisearch_python_sdk.models.task import TaskInfo
+
+
+async def add_documents_in_batches(
+    index: AsyncIndex, file_path: Path | str = "../datasets/small_movies.json"
+) -> list[TaskInfo]:
+    async with aiofiles.open(file_path) as f:
+        data = await f.read()
+        documents = json.loads(data)
+
+    # Meilisearch prefers larger batch sizes so set this as large as you can.
+    return await index.add_documents_in_batches(documents, primary_key="id", batch_size=1000)
+
+
+async def main() -> int:
+    async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        index = await client.create_index("movies", primary_key="id")
+
+        await add_documents_in_batches(index)
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(asyncio.run(main()))

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/examples/async_documents_and_search_results.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import asyncio
 import json
 from collections.abc import Sequence

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/examples/async_search_tracker.py

@@ -1,12 +1,18 @@
+from __future__ import annotations
+
 import asyncio
 import json
 import sqlite3
+from pathlib import Path
 from typing import Any
 
 import aiofiles
 
-from meilisearch_python_sdk import AsyncClient
+from meilisearch_python_sdk import AsyncClient, AsyncIndex
+from meilisearch_python_sdk.models.search import SearchResults
+from meilisearch_python_sdk.models.task import TaskInfo
 from meilisearch_python_sdk.plugins import AsyncEvent, AsyncIndexPlugins
+from meilisearch_python_sdk.types import JsonDict
 
 
 class SearchTrackerPlugin:
@@ -14,8 +20,8 @@ class SearchTrackerPlugin:
     POST_EVENT = False
     PRE_EVENT = False
 
-    def __init__(self) -> None:
-        self.conn = sqlite3.Connection("search_tracker.db")
+    def __init__(self, db_path: Path | str = "search_tracker.db") -> None:
+        self.conn = sqlite3.Connection(db_path)
         self.create_table()
 
     def create_table(self) -> None:
@@ -43,15 +49,24 @@ class SearchTrackerPlugin:
             cursor.close()
 
 
-async def main() -> int:
-    async with aiofiles.open("../datasets/small_movies.json") as f:
+async def add_documents(
+    index: AsyncIndex, file_path: Path | str = "../datasets/small_movies.json"
+) -> TaskInfo:
+    async with aiofiles.open(file_path) as f:
         data = await f.read()
         documents = json.loads(data)
+    return await index.add_documents(documents)
+
 
+async def search(index: AsyncIndex, query: str) -> SearchResults[JsonDict]:
+    return await index.search(query)
+
+
+async def main() -> int:
     async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
         plugins = AsyncIndexPlugins(search_plugins=(SearchTrackerPlugin(),))
         index = await client.create_index("movies", primary_key="id", plugins=plugins)
-        task = await index.add_documents(documents)
+        task = await add_documents(index)
         await client.wait_for_task(task.task_uid)
         result = await index.search("Cars")
         print(result)  # noqa: T201

meilisearch_python_sdk-3.5.1/examples/async_update_settings.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+import asyncio
+import json
+from pathlib import Path
+
+import aiofiles
+
+from meilisearch_python_sdk import AsyncClient, AsyncIndex
+from meilisearch_python_sdk.models.settings import MeilisearchSettings
+from meilisearch_python_sdk.models.task import TaskInfo
+
+
+async def add_documents(
+    index: AsyncIndex, file_path: Path | str = "../datasets/small_movies.json"
+) -> TaskInfo:
+    async with aiofiles.open(file_path) as f:
+        data = await f.read()
+        documents = json.loads(data)
+
+    return await index.add_documents(documents)
+
+
+async def update_settings(index: AsyncIndex) -> TaskInfo:
+    settings = MeilisearchSettings(
+        filterable_attributes=["genre"], searchable_attributes=["title", "genre", "overview"]
+    )
+
+    return await index.update_settings(settings)
+
+
+async def main() -> int:
+    async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        index = await client.create_index("movies", primary_key="id")
+        task = await update_settings(index)
+        await client.wait_for_task(task.task_uid)
+        await add_documents(index)
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(asyncio.run(main()))

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/examples/documents_and_search_results.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 from collections.abc import Sequence
 from typing import Any

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/examples/orjson_example.py

@@ -1,11 +1,20 @@
+from __future__ import annotations
+
+from pathlib import Path
+
 from meilisearch_python_sdk import Client
 from meilisearch_python_sdk.json_handler import OrjsonHandler
+from meilisearch_python_sdk.models.task import TaskInfo
 
 
-def main() -> int:
+def add_documents(file_path: Path | str = "../datasets/small_movies.json") -> TaskInfo:
     client = Client("http://127.0.0.1:7700", "masterKey", json_handler=OrjsonHandler())
     index = client.create_index("movies", primary_key="id")
-    index.add_documents_from_file("../datasets/small_movies.json")
+    return index.add_documents_from_file(file_path)
+
+
+def main() -> int:
+    add_documents()
 
     return 0
 

meilisearch_python_sdk-3.5.1/examples/pyproject.toml

@@ -0,0 +1,4 @@
+[tool.pytest.ini_options]
+minversion = "6.0"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"

meilisearch_python_sdk-3.5.1/examples/requirements.txt

@@ -0,0 +1,4 @@
+../.[all]
+fastapi==0.115.0
+pytest==8.3.3
+pytest-asyncio==0.24.0

{meilisearch_python_sdk-3.4.0 → meilisearch_python_sdk-3.5.1}/examples/search_tracker.py

@@ -1,17 +1,23 @@
+from __future__ import annotations
+
 import json
 import sqlite3
+from pathlib import Path
 from typing import Any
 
-from meilisearch_python_sdk import Client
+from meilisearch_python_sdk import Client, Index
+from meilisearch_python_sdk.models.search import SearchResults
+from meilisearch_python_sdk.models.task import TaskInfo
 from meilisearch_python_sdk.plugins import Event, IndexPlugins
+from meilisearch_python_sdk.types import JsonDict
 
 
 class SearchTrackerPlugin:
     POST_EVENT = False
     PRE_EVENT = True  # Specifies the plugin should be run before the search
 
-    def __init__(self) -> None:
-        self.conn = sqlite3.Connection("search_tracker.db")
+    def __init__(self, db_path: Path | str = "search_tracker.db") -> None:
+        self.conn = sqlite3.Connection(db_path)
         self.create_table()
 
     def create_table(self) -> None:
@@ -34,16 +40,25 @@ class SearchTrackerPlugin:
             cursor.close()
 
 
-def main() -> int:
-    with open("../datasets/small_movies.json") as f:
+def add_documents(
+    index: Index, file_path: Path | str = "../datasets/small_movies.json"
+) -> TaskInfo:
+    with open(file_path) as f:
         documents = json.load(f)
+    return index.add_documents(documents)
+
 
+def search(index: Index, query: str) -> SearchResults[JsonDict]:
+    return index.search(query)
+
+
+def main() -> int:
     client = Client("http://127.0.0.1:7700", "masterKey")
     plugins = IndexPlugins(search_plugins=(SearchTrackerPlugin(),))
     index = client.create_index("movies", primary_key="id", plugins=plugins)
-    task = index.add_documents(documents)
+    task = add_documents(index)
     client.wait_for_task(task.task_uid)
-    result = index.search("Cars")
+    result = search(index, "Cars")
     print(result)  # noqa: T201
 
     return 0

meilisearch_python_sdk-3.5.1/examples/tests/conftest.py

@@ -0,0 +1,56 @@
+from pathlib import Path
+from uuid import uuid4
+
+import pytest
+from pytest_asyncio import is_async_test
+
+from meilisearch_python_sdk import AsyncClient, Client
+
+MASTER_KEY = "masterKey"
+
+ROOT_PATH = Path().absolute()
+SMALL_MOVIES_PATH = ROOT_PATH.parent / "datasets" / "small_movies.json"
+
+
+def pytest_collection_modifyitems(items):
+    pytest_asyncio_tests = (item for item in items if is_async_test(item))
+    session_scope_marker = pytest.mark.asyncio(loop_scope="session")
+    for async_test in pytest_asyncio_tests:
+        async_test.add_marker(session_scope_marker, append=False)
+
+
+@pytest.fixture(scope="session")
+def base_url():
+    return "http://127.0.0.1:7700"
+
+
+@pytest.fixture(scope="session")
+async def async_client(base_url):
+    async with AsyncClient(base_url, MASTER_KEY) as client:
+        yield client
+
+
+@pytest.fixture(scope="session")
+def client(base_url):
+    yield Client(base_url, MASTER_KEY)
+
+
+@pytest.fixture(scope="session")
+def small_movies_path():
+    return SMALL_MOVIES_PATH
+
+
+@pytest.fixture
+async def async_empty_index(async_client):
+    async def index_maker():
+        return await async_client.create_index(uid=str(uuid4()), timeout_in_ms=5000)
+
+    return index_maker
+
+
+@pytest.fixture
+def empty_index(client):
+    def index_maker():
+        return client.create_index(uid=str(uuid4()), timeout_in_ms=5000)
+
+    return index_maker

meilisearch_python_sdk-3.5.1/examples/tests/test_async_examples.py

@@ -0,0 +1,53 @@
+import asyncio
+from uuid import uuid4
+
+from examples.async_add_documents_decorator import load_documents
+from examples.async_add_documents_in_batches import add_documents_in_batches
+from examples.async_search_tracker import SearchTrackerPlugin, search
+from examples.async_search_tracker import add_documents as search_tracker_add_documents
+from examples.async_update_settings import add_documents as update_settings_add_documents
+from examples.async_update_settings import update_settings
+from meilisearch_python_sdk.plugins import AsyncIndexPlugins
+
+
+async def test_add_documents_decorator(small_movies_path, async_client):
+    index = await async_client.create_index("movies", "id")
+    await load_documents(small_movies_path)
+    result = await async_client.get_tasks()
+    await asyncio.gather(*[async_client.wait_for_task(x.uid) for x in result.results])
+    documents = await index.get_documents()
+
+    assert len(documents.results) > 0
+
+
+async def test_add_documents_in_batchees(small_movies_path, async_empty_index, async_client):
+    index = await async_empty_index()
+    tasks = await add_documents_in_batches(index, small_movies_path)
+    for task in tasks:
+        await async_client.wait_for_task(task.task_uid)
+        result = await async_client.get_task(task.task_uid)
+        assert result.status == "succeeded"
+
+
+async def test_search_tracker(small_movies_path, async_client, tmp_path):
+    db_path = tmp_path / "search_tracker.db"
+    plugins = AsyncIndexPlugins(search_plugins=(SearchTrackerPlugin(db_path),))
+    index = await async_client.create_index(
+        uid=str(uuid4()), primary_key="id", plugins=plugins, timeout_in_ms=5000
+    )
+    task = await search_tracker_add_documents(index, small_movies_path)
+    await async_client.wait_for_task(task.task_uid)
+    result = await async_client.get_task(task.task_uid)
+    assert result.status == "succeeded"
+    result = await search(index, "Cars")
+    assert len(result.hits) > 0
+
+
+async def test_update_settings(small_movies_path, async_empty_index, async_client):
+    index = await async_empty_index()
+    task = await update_settings(index)
+    await async_client.wait_for_task(task.task_uid)
+    task = await update_settings_add_documents(index, small_movies_path)
+    await async_client.wait_for_task(task.task_uid)
+    result = await async_client.get_task(task.task_uid)
+    assert result.status == "succeeded"