meilisearch-python-sdk 4.10.1__tar.gz → 5.0.0__tar.gz

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/.github/workflows/docs_publish.yml

@@ -5,7 +5,7 @@ on:
       - published
   workflow_dispatch:
 env:
-  PYTHON_VERSION: "3.12"
+  PYTHON_VERSION: "3.13"
 jobs:
   deploy:
     runs-on: ubuntu-latest

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/.github/workflows/nightly_testing.yml

@@ -5,7 +5,7 @@ on:
     # Set with UTC time
     - cron: "0 5 * * *"
 env:
-  PYTHON_VERSION: "3.12"
+  PYTHON_VERSION: "3.13"
 jobs:
   random-test-order:
     strategy:

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/.github/workflows/pypi_publish.yml

@@ -4,7 +4,7 @@ on:
     types:
       - published
 env:
-  PYTHON_VERSION: "3.12"
+  PYTHON_VERSION: "3.13"
 jobs:
   deploy:
     runs-on: ubuntu-latest

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/.github/workflows/testing.yml

@@ -6,7 +6,7 @@ on:
       - main
   pull_request:
 env:
-  PYTHON_VERSION: "3.9"
+  PYTHON_VERSION: "3.10"
 jobs:
   linting:
     runs-on: ubuntu-latest
@@ -22,6 +22,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
+          allow-prereleases: true
       - name: Install Dependencies
         run: just install
       - name: mypy check
@@ -31,7 +32,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
@@ -45,6 +46,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
       - name: Install Dependencies
         run: just install
       - name: Test with pytest
@@ -59,7 +61,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
@@ -73,10 +75,10 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
       - 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: |
@@ -99,7 +101,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
@@ -113,6 +115,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
       - name: Install Dependencies
         run: just install
       - name: Test with pytest
@@ -127,7 +130,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
@@ -141,10 +144,10 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
       - 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: |
@@ -166,7 +169,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
@@ -176,6 +179,7 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
           cache: pip
       - name: Test with pytest
         run: just test-examples-ci

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/.pre-commit-config.yaml

@@ -9,12 +9,12 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.18.1
+    rev: v1.18.2
     hooks:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.13.0
+    rev: v0.13.3
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 4.10.1
+Version: 5.0.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
@@ -33,16 +33,15 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-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: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: aiofiles>=0.7
 Requires-Dist: camel-converter[pydantic]>=1.0.0
-Requires-Dist: eval-type-backport>=0.2.0; python_version < '3.10'
 Requires-Dist: httpx[http2]>=0.17
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: pyjwt>=2.3.0

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/meilisearch_python_sdk/_client.py

@@ -36,6 +36,7 @@ from meilisearch_python_sdk.models.search import (
 from meilisearch_python_sdk.models.settings import MeilisearchSettings
 from meilisearch_python_sdk.models.task import TaskInfo, TaskResult, TaskStatus
 from meilisearch_python_sdk.models.version import Version
+from meilisearch_python_sdk.models.webhook import Webhook, WebhookCreate, Webhooks, WebhookUpdate
 from meilisearch_python_sdk.plugins import AsyncIndexPlugins, IndexPlugins
 from meilisearch_python_sdk.types import JsonDict
 
@@ -252,6 +253,124 @@ class AsyncClient(BaseClient):
 
         return Network(**response.json())
 
+    async def get_webhooks(self) -> Webhooks:
+        """Get all webhooks.
+
+        Returns:
+            An instance of Webhooks containing all configured webhooks.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     webhooks = await client.get_webhooks()
+        """
+        response = await self._http_requests.get("webhooks")
+
+        return Webhooks(**response.json())
+
+    async def get_webhook(self, uuid: str) -> Webhook:
+        """Get a specific webhook by UUID.
+
+        Args:
+            uuid: The webhook's unique identifier.
+
+        Returns:
+            An instance of Webhook containing the webhook information.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     webhook = await client.get_webhook("abc-123")
+        """
+        response = await self._http_requests.get(f"webhooks/{uuid}")
+
+        return Webhook(**response.json())
+
+    async def create_webhook(self, webhook: WebhookCreate) -> Webhook:
+        """Create a new webhook.
+
+        Args:
+            webhook: The webhook configuration to create.
+
+        Returns:
+            The created webhook.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> from meilisearch_python_sdk.models.webhook import WebhookCreate
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     webhook_config = WebhookCreate(
+            >>>         url="https://example.com/webhook",
+            >>>         headers={"Authorization": "Bearer token"}
+            >>>     )
+            >>>     webhook = await client.create_webhook(webhook_config)
+        """
+        response = await self._http_requests.post(
+            "webhooks", webhook.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Webhook(**response.json())
+
+    async def update_webhook(self, *, uuid: str, webhook: WebhookUpdate) -> Webhook:
+        """Update an existing webhook.
+
+        Args:
+            uuid: The webhook's unique identifier.
+            webhook: The webhook configuration updates.
+
+        Returns:
+            The updated webhook.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> from meilisearch_python_sdk.models.webhook import WebhookUpdate
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     webhook_update = WebhookUpdate(url="https://example.com/new-webhook")
+            >>>     webhook = await client.update_webhook("abc-123", webhook_update)
+        """
+        response = await self._http_requests.patch(
+            f"webhooks/{uuid}", webhook.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Webhook(**response.json())
+
+    async def delete_webhook(self, uuid: str) -> int:
+        """Delete a webhook.
+
+        Args:
+            uuid: The webhook's unique identifier.
+
+        Returns:
+            The Response status code. 204 signifies a successful delete.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     await client.delete_webhook("abc-123")
+        """
+        response = await self._http_requests.delete(f"webhooks/{uuid}")
+        return response.status_code
+
     async def create_dump(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch dump.
 
@@ -1229,6 +1348,124 @@ class Client(BaseClient):
 
         return Network(**response.json())
 
+    def get_webhooks(self) -> Webhooks:
+        """Get all webhooks.
+
+        Returns:
+            An instance of Webhooks containing all configured webhooks.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> webhooks = client.get_webhooks()
+        """
+        response = self._http_requests.get("webhooks")
+
+        return Webhooks(**response.json())
+
+    def get_webhook(self, uuid: str) -> Webhook:
+        """Get a specific webhook by UUID.
+
+        Args:
+            uuid: The webhook's unique identifier.
+
+        Returns:
+            An instance of Webhook containing the webhook information.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> webhook = client.get_webhook("abc-123")
+        """
+        response = self._http_requests.get(f"webhooks/{uuid}")
+
+        return Webhook(**response.json())
+
+    def create_webhook(self, webhook: WebhookCreate) -> Webhook:
+        """Create a new webhook.
+
+        Args:
+            webhook: The webhook configuration to create.
+
+        Returns:
+            The created webhook.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> from meilisearch_python_sdk.models.webhook import WebhookCreate
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> webhook_config = WebhookCreate(
+            >>>     url="https://example.com/webhook",
+            >>>     headers={"Authorization": "Bearer token"}
+            >>> )
+            >>> webhook = client.create_webhook(webhook_config)
+        """
+        response = self._http_requests.post(
+            "webhooks", webhook.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Webhook(**response.json())
+
+    def update_webhook(self, *, uuid: str, webhook: WebhookUpdate) -> Webhook:
+        """Update an existing webhook.
+
+        Args:
+            uuid: The webhook's unique identifier.
+            webhook: The webhook configuration updates.
+
+        Returns:
+            The updated webhook.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> from meilisearch_python_sdk.models.webhook import WebhookUpdate
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> webhook_update = WebhookUpdate(url="https://example.com/new-webhook")
+            >>> webhook = client.update_webhook("abc-123", webhook_update)
+        """
+        response = self._http_requests.patch(
+            f"webhooks/{uuid}", webhook.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Webhook(**response.json())
+
+    def delete_webhook(self, uuid: str) -> int:
+        """Delete a webhook.
+
+        Args:
+            uuid: The webhook's unique identifier.
+
+        Returns:
+            The Response status code. 204 signifies a successful delete.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> client.delete_webhook("abc-123")
+        """
+        response = self._http_requests.delete(f"webhooks/{uuid}")
+        return response.status_code
+
     def create_dump(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch dump.
 

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/meilisearch_python_sdk/_http_requests.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
 import gzip
+from collections.abc import Callable
 from functools import lru_cache
-from typing import Any, Callable
+from typing import Any
 
 from httpx import (
     AsyncClient,

meilisearch_python_sdk-5.0.0/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/meilisearch_python_sdk/decorators.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
 import asyncio
+from collections.abc import Callable
 from functools import wraps
-from typing import Any, Callable, NamedTuple
+from typing import Any, NamedTuple
 
 from meilisearch_python_sdk import AsyncClient, Client
 from meilisearch_python_sdk._utils import use_task_groups

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/meilisearch_python_sdk/models/version.py

@@ -1,10 +1,9 @@
 from datetime import datetime
-from typing import Union
 
 from camel_converter.pydantic_base import CamelBase
 
 
 class Version(CamelBase):
     commit_sha: str
-    commit_date: Union[datetime, str]
+    commit_date: datetime | str
     pkg_version: str

meilisearch_python_sdk-5.0.0/meilisearch_python_sdk/models/webhook.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from camel_converter.pydantic_base import CamelBase
+
+
+class Webhook(CamelBase):
+    uuid: str
+    url: str
+    headers: dict[str, str] | None = None
+    is_editable: bool
+
+
+class Webhooks(CamelBase):
+    results: list[Webhook]
+
+
+class WebhookCreate(CamelBase):
+    url: str
+    headers: dict[str, str] | None = None
+
+
+class WebhookUpdate(CamelBase):
+    url: str | None = None
+    headers: dict[str, str] | None = None

meilisearch_python_sdk-5.0.0/meilisearch_python_sdk/types.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from collections.abc import MutableMapping
+from typing import Any, TypeAlias
+
+Filter: TypeAlias = str | list[str | list[str]]
+JsonDict: TypeAlias = dict[str, Any]
+JsonMapping: TypeAlias = MutableMapping[str, Any]

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/pyproject.toml

@@ -6,18 +6,18 @@ build-backend = "hatchling.build"
 name = "meilisearch-python-sdk"
 description = "A Python client providing both async and sync support for the Meilisearch API"
 authors = [ { name = "Paul Sanders", email = "paul@paulsanders.dev" } ]
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 license = { file = "LICENSE" }
 readme = "README.md"
 keywords = ["meilisearch", "async", "python", "client", "sdk"]
 classifiers=[
   "Development Status :: 5 - Production/Stable",
   "Intended Audience :: Developers",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
   "Typing :: Typed",
@@ -26,8 +26,6 @@ dynamic = ["version"]
 dependencies = [
   "aiofiles>=0.7",
   "camel-converter[pydantic]>=1.0.0",
-  # allows pydantic to use pipe instead of Union
-  "eval-type-backport>=0.2.0; python_version < '3.10'",
   "httpx[http2]>=0.17",
   "pydantic>=2.0.0",
   "PyJWT>=2.3.0",
@@ -41,15 +39,15 @@ all = ["orjson", "ujson"]
 [dependency-groups]
 dev = [
   "mkdocs==1.6.1",
-  "mkdocs-material==9.6.20",
-  "mkdocstrings[python]==0.30.0",
+  "mkdocs-material==9.6.21",
+  "mkdocstrings[python]==0.30.1",
   "mypy[faster-cache]==1.18.2",
   "pre-commit==4.3.0",
   "pytest==8.4.2",
   "pytest-cov==7.0.0",
   "pytest-asyncio==1.2.0",
   "pytest-xdist==3.8.0",
-  "ruff==0.13.1",
+  "ruff==0.13.3",
   "types-aiofiles==24.1.0.20250822",
   "typing-extensions==4.15.0",
   "types-ujson==5.10.0.20250822",
@@ -87,7 +85,7 @@ ignore_missing_imports = true
 
 [tool.ruff]
 line-length = 100
-target-version = "py39"
+target-version = "py310"
 fix = true
 
 [tool.ruff.lint]

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-5.0.0}/tests/conftest.py

@@ -2,7 +2,6 @@ import asyncio
 import csv
 import json
 import ssl
-import sys
 from logging import warning
 from pathlib import Path
 from uuid import uuid4
@@ -18,6 +17,7 @@ from httpx 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, UjsonHandler
 from meilisearch_python_sdk.models.settings import (
     Embedders,
@@ -29,6 +29,7 @@ from meilisearch_python_sdk.models.settings import (
     TypoTolerance,
     UserProvidedEmbedder,
 )
+from meilisearch_python_sdk.models.webhook import WebhookCreate
 
 MASTER_KEY = "masterKey"
 
@@ -53,10 +54,7 @@ def ssl_verify(http2_enabled):
             return truststore.SSLContext(ssl.PROTOCOL_TLS_CLIENT) if http2_enabled else True
         return True  # recommended default
     else:  # truststore isn't installed
-        if sys.version_info >= (3, 10):  # should be available in 3.10+
-            warning("truststore not installed, your environment may be broken run uv sync")
-        # without truststore we can't verify the ssl (and when http2 is enabled, verification must be disabled)
-        return not http2_enabled
+        warning("truststore not installed, your environment may be broken run uv sync")
 
 
 @pytest.fixture(scope="session")
@@ -353,3 +351,17 @@ def new_settings_localized():
             LocalizedAttributes(locales=["ita"], attribute_patterns=["*_it"]),
         ],
     )
+
+
+@pytest.fixture
+def webhook(client):
+    webhook_config = WebhookCreate(url="https://example.com/webhook")
+    webhook = client.create_webhook(webhook_config)
+
+    yield webhook
+
+    try:
+        client.delete_webhook(webhook.uuid)
+    except MeilisearchApiError as e:
+        if "webhook_not_found" in str(e):
+            pass