meilisearch-python-sdk 7.3.0__tar.gz → 7.4.0__tar.gz

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/.github/workflows/docs_publish.yml

@@ -16,11 +16,11 @@ jobs:
     steps:
       - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/.github/workflows/nightly_testing.yml

@@ -14,13 +14,13 @@ jobs:
     steps:
       - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies

meilisearch_python_sdk-7.4.0/.github/workflows/prek_update.yml

@@ -0,0 +1,36 @@
+name: Prek Auto Update
+
+on:
+  schedule:
+    - cron: "0 2 * * *"
+  workflow_dispatch:
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v9.0.0
+        with:
+          enable-cache: true
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: 3.14
+      - name: Run Update
+        run: uv run prek autoupdate
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v8
+        with:
+          token: ${{ secrets.PREK_UPDATE_TOKEN }}
+          commit-message: "Bump prek hooks"
+          branch: prek-autoupdate
+          delete-branch: true
+          title: "Bump prek hooks"
+          body: "Automated update of prek hooks via `prek autoupdate`."
+          labels: |
+            dependencies
+            skip-changelog

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/.github/workflows/pypi_publish.yml

@@ -14,11 +14,11 @@ jobs:
     steps:
       - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/.github/workflows/testing.yml

@@ -15,11 +15,11 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           allow-prereleases: true
@@ -27,7 +27,13 @@ jobs:
         run: just install
       - name: pyrefly check
         run: just pyrefly
-
+  prek:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: j178/prek-action@v2
+        env:
+          PREK_SKIP: no-commit-to-branch,pyrefly-check
   parallel-testing:
     strategy:
       fail-fast: false
@@ -39,11 +45,11 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
@@ -57,7 +63,6 @@ jobs:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
           fail_ci_if_error: true
-
   parallel-testing-http2:
     strategy:
       fail-fast: false
@@ -69,11 +74,11 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
@@ -98,7 +103,6 @@ jobs:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
           fail_ci_if_error: true
-
   no-parallel-testing:
     strategy:
       fail-fast: false
@@ -110,11 +114,11 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
@@ -128,7 +132,6 @@ jobs:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
           fail_ci_if_error: true
-
   no-parallel-testing-http2:
     strategy:
       fail-fast: false
@@ -140,11 +143,11 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
@@ -180,14 +183,13 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
           cache: pip
       - name: Test with pytest
         run: just test-examples-ci
-
   docs:
     runs-on: ubuntu-latest
     steps:
@@ -195,11 +197,11 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: "3.14"
       - name: Install Dependencies

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 7.3.0
+Version: 7.4.0
 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
@@ -53,7 +53,6 @@ Description-Content-Type: text/markdown
 # Meilisearch Python SDK
 
 [![Tests Status](https://github.com/sanders41/meilisearch-python-sdk/actions/workflows/testing.yml/badge.svg?branch=main&event=push)](https://github.com/sanders41/meilisearch-python-sdk/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sanders41/meilisearch-python-sdk/main.svg)](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-python-sdk/main)
 [![Coverage](https://codecov.io/github/sanders41/meilisearch-python-sdk/coverage.svg?branch=main)](https://codecov.io/gh/sanders41/meilisearch-python-sdk)
 [![PyPI version](https://badge.fury.io/py/meilisearch-python-sdk.svg)](https://badge.fury.io/py/meilisearch-python-sdk)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/meilisearch-python-sdk?color=5cc141)](https://github.com/sanders41/meilisearch-python-sdk)
@@ -77,6 +76,12 @@ environment is created and activated, install the package with:
 pip install meilisearch-python-sdk
 ```
 
+Installing with the orjson extra will make JSON serilization/deserilization faster.
+
+```sh
+pip install meilisearch-python-sdk[orjson]
+```
+
 ## Run Meilisearch
 
 There are several ways to

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/README.md

@@ -1,7 +1,6 @@
 # Meilisearch Python SDK
 
 [![Tests Status](https://github.com/sanders41/meilisearch-python-sdk/actions/workflows/testing.yml/badge.svg?branch=main&event=push)](https://github.com/sanders41/meilisearch-python-sdk/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sanders41/meilisearch-python-sdk/main.svg)](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-python-sdk/main)
 [![Coverage](https://codecov.io/github/sanders41/meilisearch-python-sdk/coverage.svg?branch=main)](https://codecov.io/gh/sanders41/meilisearch-python-sdk)
 [![PyPI version](https://badge.fury.io/py/meilisearch-python-sdk.svg)](https://badge.fury.io/py/meilisearch-python-sdk)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/meilisearch-python-sdk?color=5cc141)](https://github.com/sanders41/meilisearch-python-sdk)
@@ -25,6 +24,12 @@ environment is created and activated, install the package with:
 pip install meilisearch-python-sdk
 ```
 
+Installing with the orjson extra will make JSON serilization/deserilization faster.
+
+```sh
+pip install meilisearch-python-sdk[orjson]
+```
+
 ## Run Meilisearch
 
 There are several ways to

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/docker-compose.https.yml

@@ -1,6 +1,6 @@
 services:
   meilisearch:
-    image: getmeili/meilisearch:v1.49.0
+    image: getmeili/meilisearch:v1.51.0
     ports:
       - "7700:7700"
     environment:

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   meilisearch:
-    image: getmeili/meilisearch:v1.49.0
+    image: getmeili/meilisearch:v1.51.0
     ports:
       - "7700:7700"
     environment:

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/docs/index.md

@@ -13,3 +13,18 @@ If the code base you are working with uses asyncio, for example if you are using
 The functionality of the two clients is the same, the difference being the `AsyncClient` provides
 async methods and uses the `AsyncIndex`, which also provides async methods, while the `Client`
 provides blocking methods and uses the `Index`, which also provides blocking methods.
+
+## Instillation
+
+Using a virtual environment is recommended for installing this package. Once the virtual
+environment is created and activated, install the package with:
+
+```sh
+pip install meilisearch-python-sdk
+```
+
+Installing with the orjson extra will make JSON serilization/deserilization faster.
+
+```sh
+pip install meilisearch-python-sdk[orjson]
+```

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/docs/json_handler.md

@@ -44,6 +44,9 @@ with Client("http://127.0.0.1:7700", json_handler=BuiltinHandler(serializer=Cust
 
 ## orjson
 
+Note that if orjson is installed and no `json_handler` is secified, orjson is used as the handler
+by default.
+
 ### Example
 
 ```py

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/meilisearch_python_sdk/_client/_async_client.py

@@ -87,7 +87,7 @@ class AsyncClient(BaseClient):
             json_handler: The module to use for json operations. The options are BuiltinHandler
                 (uses the json module from the standard library), or OrjsonHandler (uses orjson).
                 Note that in order use orjson the corresponding extra needs to be included.
-                Default: BuiltinHandler.
+                Default: OrjsonHandler if orjson is installed or BuiltinHandler if not.
             http2: Whether or not to use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/meilisearch_python_sdk/_client/_base_client.py

@@ -11,6 +11,11 @@ from meilisearch_python_sdk.models.client import (
 )
 from meilisearch_python_sdk.types import JsonDict
 
+try:
+    import orjson
+except ImportError:  # pragma: no cover
+    orjson = None  # type: ignore
+
 if TYPE_CHECKING:
     from meilisearch_python_sdk.types import JsonMapping
 
@@ -22,7 +27,13 @@ class BaseClient:
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | None = None,
     ) -> None:
-        self.json_handler = json_handler if json_handler else BuiltinHandler()
+        if json_handler is not None:
+            self.json_handler = json_handler
+        elif orjson is not None:
+            self.json_handler = OrjsonHandler()
+        else:
+            self.json_handler = BuiltinHandler()
+
         self._headers: dict[str, str] | None = None
         if api_key:
             self._headers = {"Authorization": f"Bearer {api_key}"}

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/meilisearch_python_sdk/_client/_client.py

@@ -88,7 +88,7 @@ class Client(BaseClient):
             json_handler: The module to use for json operations. The options are BuiltinHandler
                 (uses the json module from the standard library), or OrjsonHandler (uses orjson).
                 Note that in order use orjson the corresponding extra needs to be included.
-                Default: BuiltinHandler.
+                Default: OrjsonHandler if orjson is installed or BuiltinHandler if not.
             http2: If set to True, the client will use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)

meilisearch_python_sdk-7.4.0/meilisearch_python_sdk/_version.py

@@ -0,0 +1 @@
+VERSION = "7.4.0"

meilisearch_python_sdk-7.4.0/prek.toml

@@ -0,0 +1,53 @@
+[update]
+exclude_tags = ["*-{alpha,beta,dev,rc}*", "*.{alpha,beta,dev,rc}*"]
+
+[[repos]]
+repo = "builtin"
+hooks = [
+  { id = "check-added-large-files" },
+  { id = "check-toml" },
+  { id = "check-yaml" },
+  { id = "end-of-file-fixer" },
+  { id = "no-commit-to-branch" },
+  { id = "trailing-whitespace" },
+]
+
+[[repos]]
+repo = "https://github.com/pre-commit/pre-commit-hooks"
+rev = "v6.0.0"
+hooks = [
+  { id = "debug-statements" },
+]
+
+[[repos]]
+repo = "https://github.com/facebook/pyrefly-pre-commit"
+rev = "1.1.1"
+hooks = [
+  {
+    id = "pyrefly-check",
+    name = "pyrefly",
+    pass_filenames = false,
+    language = "system",
+    entry = "uv run pyrefly check"
+  }
+]
+
+[[repos]]
+repo = "https://github.com/astral-sh/ruff-pre-commit"
+rev = "v0.16.0"
+hooks = [
+  {
+    id = "ruff-check",
+    args = [
+      "--fix",
+      "--exit-non-zero-on-fix"
+    ]
+  }
+]
+
+[[repos]]
+repo = "https://github.com/rvben/rumdl-pre-commit"
+rev = "v0.2.45"
+hooks = [
+  { id = "rumdl-fmt" }
+]

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/pyproject.toml

@@ -42,11 +42,11 @@ dev = [
   "pytest-cov==7.1.0",
   "pytest-asyncio==1.4.0",
   "pytest-xdist==3.8.0",
-  "prek==0.4.9",
-  "ruff==0.15.21",
+  "prek==0.4.11",
+  "ruff==0.16.0",
   "types-aiofiles==25.1.0.20260518",
   "typing-extensions==4.16.0",
-  "zensical==0.0.50",
+  "zensical==0.0.51",
 ]
 
 [tool.hatch.version]

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/tests/conftest.py

@@ -18,7 +18,7 @@ from httpx2 import AsyncClient as HttpxAsyncClient
 from meilisearch_python_sdk import AsyncClient, Client
 from meilisearch_python_sdk._task import async_wait_for_task, wait_for_task
 from meilisearch_python_sdk.errors import MeilisearchApiError
-from meilisearch_python_sdk.json_handler import OrjsonHandler
+from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
 from meilisearch_python_sdk.models.settings import (
     Embedders,
     Faceting,
@@ -59,7 +59,9 @@ def ssl_verify(http2_enabled):
 
 @pytest.fixture(scope="session")
 async def async_client(base_url, ssl_verify):
-    async with AsyncClient(base_url, MASTER_KEY, verify=ssl_verify) as client:
+    async with AsyncClient(
+        base_url, MASTER_KEY, json_handler=BuiltinHandler(), verify=ssl_verify
+    ) as client:
         yield client
 
 
@@ -79,7 +81,7 @@ async def async_client_with_plugins(base_url, ssl_verify):
 
 @pytest.fixture(scope="session")
 def client(base_url, ssl_verify):
-    with Client(base_url, MASTER_KEY, verify=ssl_verify) as client:
+    with Client(base_url, MASTER_KEY, json_handler=BuiltinHandler(), verify=ssl_verify) as client:
         yield client
 
 

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/tests/test_async_client.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import asyncio
 from datetime import datetime, timedelta, timezone
+from unittest.mock import patch
 from urllib.parse import quote_plus
 from uuid import uuid4
 
@@ -73,6 +74,23 @@ async def wait_for_dump_creation(
     raise TimeoutError
 
 
+@pytest.mark.parametrize(
+    "json_handler, expected",
+    ((None, OrjsonHandler), (BuiltinHandler(), BuiltinHandler), (OrjsonHandler(), OrjsonHandler)),
+)
+def test_json_handler(json_handler, expected):
+    client = AsyncClient("http://localhost", "someKey", json_handler=json_handler)
+
+    assert isinstance(client.json_handler, expected)
+
+
+def test_default_json_handler_no_orjson():
+    with patch("meilisearch_python_sdk._client._base_client.orjson", None):
+        client = AsyncClient("http://localhost", "someKey")
+
+    assert isinstance(client.json_handler, BuiltinHandler)
+
+
 @pytest.mark.parametrize(
     "api_key, custom_headers, expected",
     (

{meilisearch_python_sdk-7.3.0 → meilisearch_python_sdk-7.4.0}/tests/test_client.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from datetime import datetime, timedelta, timezone
 from time import sleep
+from unittest.mock import patch
 from urllib.parse import quote_plus
 from uuid import uuid4
 
@@ -68,6 +69,23 @@ def wait_for_dump_creation(client, dump_uid, timeout_in_ms=10000.0, interval_in_
     raise TimeoutError
 
 
+@pytest.mark.parametrize(
+    "json_handler, expected",
+    ((None, OrjsonHandler), (BuiltinHandler(), BuiltinHandler), (OrjsonHandler(), OrjsonHandler)),
+)
+def test_json_handler(json_handler, expected):
+    client = Client("http://localhost", "someKey", json_handler=json_handler)
+
+    assert isinstance(client.json_handler, expected)
+
+
+def test_default_json_handler_no_orjson():
+    with patch("meilisearch_python_sdk._client._base_client.orjson", None):
+        client = Client("http://localhost", "someKey")
+
+    assert isinstance(client.json_handler, BuiltinHandler)
+
+
 @pytest.mark.parametrize(
     "api_key, custom_headers, expected",
     (