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

{meilisearch_python_sdk-7.2.3 → 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.2.0
+        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.2.3 → 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.2.0
+        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.2.3 → 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.2.0
+        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.2.3 → 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.2.0
+        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.2.0
+        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.2.0
+        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.2.0
+        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.2.0
+        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.2.0
+        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.2.3 → meilisearch_python_sdk-7.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 7.2.3
+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.2.3 → 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.2.3 → meilisearch_python_sdk-7.4.0}/docker-compose.https.yml

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

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

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

{meilisearch_python_sdk-7.2.3 → 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.2.3 → 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.2.3 → 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.2.3 → 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.2.3 → 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.2.3 → meilisearch_python_sdk-7.4.0}/meilisearch_python_sdk/_client/_common.py

@@ -41,6 +41,9 @@ def build_multi_search_payload(
         if query.show_performance_details is None:
             del q["showPerformanceDetails"]
 
+        if query.personalize is None:
+            del q["personalize"]
+
         processed_queries.append(q)
 
     if federation:

meilisearch_python_sdk-7.4.0/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-7.2.3 → meilisearch_python_sdk-7.4.0}/meilisearch_python_sdk/index/_common.py

@@ -11,7 +11,7 @@ from pydantic import TypeAdapter
 
 from meilisearch_python_sdk.errors import MeilisearchError
 from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
-from meilisearch_python_sdk.models.search import Hybrid
+from meilisearch_python_sdk.models.search import Hybrid, Personalize
 from meilisearch_python_sdk.models.settings import (
     CompositeEmbedder,
     Embedders,
@@ -153,6 +153,7 @@ def process_search_parameters(
     exhaustive_facet_count: bool | None = None,
     media: JsonMapping | None = None,
     show_performance_details: bool = False,
+    personalize: Personalize | None = None,
 ) -> JsonDict:
     if attributes_to_retrieve is None:
         attributes_to_retrieve = ["*"]
@@ -213,6 +214,11 @@ def process_search_parameters(
     if show_performance_details:
         body["showPerformanceDetails"] = True
 
+    # no cover becuse personlized search requires an api key and any mocked test here would be
+    # pointless
+    if personalize is not None:  # pragma: no cover
+        body["personalize"] = personalize.model_dump(by_alias=True)
+
     return body
 
 

{meilisearch_python_sdk-7.2.3 → meilisearch_python_sdk-7.4.0}/meilisearch_python_sdk/index/async_index.py

@@ -36,6 +36,7 @@ from meilisearch_python_sdk.models.index import Field, FieldResults, FieldsFilte
 from meilisearch_python_sdk.models.search import (
     FacetSearchResults,
     Hybrid,
+    Personalize,
     SearchResults,
     SimilarSearchResults,
 )
@@ -44,6 +45,7 @@ from meilisearch_python_sdk.models.settings import (
     Faceting,
     FilterableAttributeFeatures,
     FilterableAttributes,
+    ForeignKey,
     LocalizedAttributes,
     MeilisearchSettings,
     Pagination,
@@ -593,6 +595,7 @@ class AsyncIndex(BaseIndex):
         retrieve_vectors: bool | None = None,
         media: JsonMapping | None = None,
         show_performance_details: bool = False,
+        personalize: Personalize | None = None,
     ) -> SearchResults:
         """Search the index.
 
@@ -663,6 +666,7 @@ class AsyncIndex(BaseIndex):
                 without a major version bump so use with caution.
             show_performance_details: When set to true, the search response contains a performance
                 trace. Default False.
+            personalize: Personalize the search results.
 
         Returns:
             Results of the search
@@ -709,6 +713,7 @@ class AsyncIndex(BaseIndex):
             retrieve_vectors=retrieve_vectors,
             media=media,
             show_performance_details=show_performance_details,
+            personalize=personalize,
         )
         search_url = f"{self._base_url_with_uid}/search"
 
@@ -739,6 +744,7 @@ class AsyncIndex(BaseIndex):
                 show_ranking_score_details=show_ranking_score_details,
                 vector=vector,
                 hybrid=hybrid,
+                personalize=personalize,
             )
 
         if self._concurrent_search_plugins:
@@ -771,6 +777,7 @@ class AsyncIndex(BaseIndex):
                                 show_ranking_score=show_ranking_score,
                                 show_ranking_score_details=show_ranking_score_details,
                                 vector=vector,
+                                personalize=personalize,
                             )
                         )
 
@@ -815,6 +822,7 @@ class AsyncIndex(BaseIndex):
                                 show_ranking_score=show_ranking_score,
                                 show_ranking_score_details=show_ranking_score_details,
                                 vector=vector,
+                                personalize=personalize,
                             )
                         )
 
@@ -872,6 +880,7 @@ class AsyncIndex(BaseIndex):
         vector: list[float] | None = None,
         locales: list[str] | None = None,
         retrieve_vectors: bool | None = None,
+        personalize: Personalize | None = None,
         exhaustive_facet_count: bool | None = None,
     ) -> FacetSearchResults:
         """Search the index.
@@ -926,6 +935,7 @@ class AsyncIndex(BaseIndex):
             locales: Specifies the languages for the search. This parameter can only be used with
                 Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
             retrieve_vectors: Return document vector data with search result.
+            personalize: Personalize the search results.
             exhaustive_facet_count: forcing the facet search to compute the facet counts the same
                 way as the paginated search. This parameter can only be used with Milisearch >=
                 v1.14.0. Defaults to None.
@@ -977,6 +987,7 @@ class AsyncIndex(BaseIndex):
             vector=vector,
             locales=locales,
             retrieve_vectors=retrieve_vectors,
+            personalize=personalize,
             exhaustive_facet_count=exhaustive_facet_count,
         )
         search_url = f"{self._base_url_with_uid}/facet-search"
@@ -1008,6 +1019,7 @@ class AsyncIndex(BaseIndex):
                 ranking_score_threshold=ranking_score_threshold,
                 vector=vector,
                 exhaustive_facet_count=exhaustive_facet_count,
+                personalize=personalize,
             )
 
         if self._concurrent_facet_search_plugins:
@@ -1041,6 +1053,7 @@ class AsyncIndex(BaseIndex):
                                 ranking_score_threshold=ranking_score_threshold,
                                 vector=vector,
                                 exhaustive_facet_count=exhaustive_facet_count,
+                                personalize=personalize,
                             )
                         )
 
@@ -1085,6 +1098,7 @@ class AsyncIndex(BaseIndex):
                                 ranking_score_threshold=ranking_score_threshold,
                                 vector=vector,
                                 exhaustive_facet_count=exhaustive_facet_count,
+                                personalize=personalize,
                             )
                         )
 
@@ -4665,6 +4679,81 @@ class AsyncIndex(BaseIndex):
 
         return TaskInfo(**self._http_requests.parse_json(response))
 
+    async def get_foreign_keys(self) -> list[ForeignKey]:
+        """Get foreign keys for the index.
+
+        Returns:
+            A list of the foreign keys
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_async_client import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = await client.index("movies")
+            >>>     foreign_keys = await index.get_foreign_keys()
+        """
+        response = await self._http_requests.get(f"{self._settings_url}/foreign-keys")
+        foreign_keys = self._http_requests.parse_json(response)
+
+        return [ForeignKey(**foreign_key) for foreign_key in foreign_keys]
+
+    async def update_foreign_keys(
+        self,
+        foreign_keys: Sequence[ForeignKey],
+        *,
+        compress: bool = False,
+    ) -> TaskInfo:
+        """Update setting for foreign key.
+
+        Args:
+            foreign_keys: List of foreign keys.
+            compress: If set to True the data will be sent in gzip format. Defaults to False.
+
+        Returns:
+            The details of the task status.
+
+        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.settings import ForeignKey
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = await client.index("movies")
+            >>>     await index.update_foreign_keys([ForeignKey(foreign_index_uid="title", field_name="title")])
+        """
+        response = await self._http_requests.put(
+            f"{self._settings_url}/foreign-keys",
+            [foreign_key.model_dump(by_alias=True) for foreign_key in foreign_keys],
+            compress=compress,
+        )
+
+        return TaskInfo(**self._http_requests.parse_json(response))
+
+    async def reset_foreign_keys(self) -> TaskInfo:
+        """Reset the foreign keys setting.
+
+        Returns:
+            The details of the task status.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_async_client import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = await client.index("movies")
+            >>>     await index.reset_foreign_keys()
+        """
+        response = await self._http_requests.delete(f"{self._settings_url}/foreign-keys")
+
+        return TaskInfo(**self._http_requests.parse_json(response))
+
     async def fields(
         self, offset: int = 0, limit: int = 20, filter: FieldsFilter | None = None
     ) -> FieldResults: