meilisearch-python-sdk 7.5.0__tar.gz → 7.5.2__tar.gz

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/.github/workflows/docs_publish.yml

@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/.github/workflows/nightly_testing.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: install Just

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/.github/workflows/prek_update.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/.github/workflows/pypi_publish.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/.github/workflows/testing.yml

@@ -15,7 +15,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python
@@ -45,7 +45,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -74,7 +74,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -114,7 +114,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -143,7 +143,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -197,7 +197,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v9.0.0
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.5
 Name: meilisearch-python-sdk
-Version: 7.5.0
+Version: 7.5.2
 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
 Project-URL: documentation, https://meilisearch-python-sdk.paulsanders.dev
+Project-URL: funding, https://github.com/sponsors/sanders41
 Author-email: Paul Sanders <paul@paulsanders.dev>
 License: MIT License
         

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/docker-compose.https.yml

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

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/docker-compose.yml

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

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/docs/async_client_api.md

@@ -6,7 +6,7 @@ This client runs in a context manager which ensures that everything is cleaned u
 the client is done. To create a client:
 
 ```py
-from meilisearch-python-sdk import AsyncClient
+from meilisearch_python_sdk import AsyncClient
 
 
 async with AsyncClient("http://localhost:7700", "masterKey") as client:
@@ -37,7 +37,7 @@ It is also possible to call the client without using a context manager, but in d
 need to make sure to do the cleanup yourself:
 
 ```py
-from meilisearch-python-sdk import AsyncClient
+from meilisearch_python_sdk import AsyncClient
 
 
 try:

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/docs/client_api.md

@@ -6,7 +6,7 @@ This client runs in a context manager which ensures that everything is cleaned u
 the client is done. To create a client:
 
 ```py
-from meilisearch-python-sdk import Client
+from meilisearch_python_sdk import Client
 
 
 with Client("http://localhost:7700", "masterKey") as client:
@@ -37,7 +37,7 @@ It is also possible to call the client without using a context manager, but in d
 need to make sure to do the cleanup yourself:
 
 ```py
-from meilisearch-python-sdk import Client
+from meilisearch_python_sdk import Client
 
 
 try:

meilisearch_python_sdk-7.5.2/docs/errors_api.md

@@ -0,0 +1,9 @@
+## Errors
+
+These are the exceptions raised by the SDK. `MeilisearchApiError` is raised when Meilisearch
+returns an error response, and `MeilisearchCommunicationError` is raised when Meilisearch cannot
+be reached at all. The token errors are raised when generating or validating tenant tokens.
+
+## Errors API
+
+::: meilisearch_python_sdk.errors

meilisearch_python_sdk-7.5.2/docs/index.md

@@ -0,0 +1,217 @@
+# Meilisearch Python SDK
+
+Meilisearch Python SDK provides both an async and sync client for the
+[Meilisearch](https://github.com/meilisearch/meilisearch) API.
+
+The focus of this documentation is on the Meilisearch Python SDK API. More information of
+Meilisearch itself and how to use it can be found at [https://www.meilisearch.com/docs](https://www.meilisearch.com/docs).
+
+## Which client to chose
+
+If the code base you are working with uses asyncio, for example if you are using
+[FastAPI](https://fastapi.tiangolo.com/), chose the `AsyncClint` otherwise chose the `Client`.
+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]
+```
+
+## Run Meilisearch
+
+This package talks to a running Meilisearch server, so you will need one to connect to. There are
+several ways to
+[run Meilisearch](https://www.meilisearch.com/docs/learn/getting_started/installation), pick the
+one that works best for your use case and then start the server. As an example, to use Docker:
+
+```sh
+docker pull getmeili/meilisearch:latest
+docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
+```
+
+## Quickstart
+
+The examples below add two documents to a `books` index and then search it. Note that
+`client.index("books")` creates an index instance but does not make a network call, so with the
+`AsyncClient` it does not need to be awaited.
+
+### AsyncClient
+
+```py
+import asyncio
+
+from meilisearch_python_sdk import AsyncClient
+
+
+async def main() -> None:
+    async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        index = client.index("books")
+
+        documents = [
+            {"id": 1, "title": "Ready Player One"},
+            {"id": 42, "title": "The Hitchhiker's Guide to the Galaxy"},
+        ]
+
+        task = await index.add_documents(documents)
+        await client.wait_for_task(task.task_uid)
+
+        result = await index.search("ready player")
+        print(result.hits)
+
+
+asyncio.run(main())
+```
+
+### Client
+
+```py
+from meilisearch_python_sdk import Client
+
+
+with Client("http://127.0.0.1:7700", "masterKey") as client:
+    index = client.index("books")
+
+    documents = [
+        {"id": 1, "title": "Ready Player One"},
+        {"id": 42, "title": "The Hitchhiker's Guide to the Galaxy"},
+    ]
+
+    task = index.add_documents(documents)
+    client.wait_for_task(task.task_uid)
+
+    result = index.search("ready player")
+    print(result.hits)
+```
+
+## Waiting on tasks
+
+Meilisearch processes writes asynchronously, so methods that modify data return a
+[`TaskInfo`](models_task.md) instead of the result of the write. The `task_uid` on it can be used
+to wait for the write to finish, or to check on its status later.
+
+```py
+task = index.add_documents([{"id": 1, "title": "Ready Player One"}])
+result = client.wait_for_task(task.task_uid)
+```
+
+If you would rather check the status yourself instead of blocking, use `get_task`.
+
+```py
+task = index.add_documents([{"id": 1, "title": "Ready Player One"}])
+status = client.get_task(task.task_uid)
+```
+
+The `AsyncClient` provides the same methods as awaitables.
+
+## Search results
+
+Searching returns a [`SearchResults`](models_search.md) object. The matching documents are in
+`hits`, and the remaining fields describe the search that was run.
+
+```py
+SearchResults(
+    hits=[
+        {
+            "id": 1,
+            "title": "Ready Player One",
+        },
+    ],
+    offset=0,
+    limit=20,
+    estimated_total_hits=1,
+    processing_time_ms=1,
+    query="ready player",
+    facet_distribution=None,
+    facet_stats=None,
+    total_pages=None,
+    total_hits=None,
+    page=None,
+    hits_per_page=None,
+    semantic_hit_count=None,
+    query_vector=None,
+    performance_details=None,
+)
+```
+
+## Custom search
+
+`search` accepts the Meilisearch
+[search parameters](https://www.meilisearch.com/docs/reference/api/search/search-with-post) as
+keyword arguments. For example, to highlight the matching terms in the title and only return books
+with an `id` above 10:
+
+```py
+index.search(
+    "guide",
+    attributes_to_highlight=["title"],
+    filter="id > 10",
+)
+```
+
+The highlighted values are added to each hit in a `_formatted` key.
+
+```py
+SearchResults(
+    hits=[
+        {
+            "id": 42,
+            "title": "The Hitchhiker's Guide to the Galaxy",
+            "_formatted": {
+                "id": "42",
+                "title": "The Hitchhiker's <em>Guide</em> to the Galaxy",
+            },
+        },
+    ],
+    offset=0,
+    limit=20,
+    estimated_total_hits=1,
+    processing_time_ms=5,
+    query="guide",
+    facet_distribution=None,
+    facet_stats=None,
+    total_pages=None,
+    total_hits=None,
+    page=None,
+    hits_per_page=None,
+    semantic_hit_count=None,
+    query_vector=None,
+    performance_details=None,
+)
+```
+
+Note that filtering only works on attributes that have been added to the index's filterable
+attributes first, otherwise Meilisearch returns an error.
+
+```py
+task = index.update_filterable_attributes(["id"])
+client.wait_for_task(task.task_uid)
+```
+
+See the [settings models](models_settings.md) for the rest of the settings that can be updated.
+
+## Where to go next
+
+- [AsyncClient](async_client_api.md) and [Client](client_api.md) for the server level methods,
+  such as managing indexes, API keys, and tasks.
+- [AsyncIndex](async_index_api.md) and [Index](index_api.md) for the methods that work with
+  documents, searching, and index settings.
+- [Search models](models_search.md), [settings models](models_settings.md),
+  [index models](models_index.md), [task models](models_task.md), and
+  [client models](models_client.md) for the objects the methods accept and return.
+- [Errors](errors_api.md) for the exceptions the SDK raises.
+- [Plugins](plugins.md) for extending the behavior of the index methods.
+- [JSON Handler](json_handler.md) for controlling JSON serialization, including using orjson.
+- [Pydantic](pydantic.md) for deserializing your documents into your own Pydantic models.
+- [Decorators](decorators_api.md) for the helpers provided for working with Meilisearch.

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/docs/json_handler.md

@@ -64,3 +64,7 @@ with Client("http://127.0.0.1:7700", json_handler=OrjsonHandler()) as client:
     index = client.index("movies", primary_key="id")
     index.add_documents(documents)
 ```
+
+## JSON Handler API
+
+::: meilisearch_python_sdk.json_handler

meilisearch_python_sdk-7.5.2/docs/models_client.md

@@ -0,0 +1,22 @@
+## Client Models
+
+These are the models returned by, and passed to, the methods on the `AsyncClient` and `Client`
+that work at the server level rather than on a single index. This covers API keys, the network
+configuration used for remote federated search, webhooks, and the health and version information
+for the server.
+
+## Client Models API
+
+::: meilisearch_python_sdk.models.client
+
+## Webhook Models API
+
+::: meilisearch_python_sdk.models.webhook
+
+## Health Models API
+
+::: meilisearch_python_sdk.models.health
+
+## Version Models API
+
+::: meilisearch_python_sdk.models.version

meilisearch_python_sdk-7.5.2/docs/models_index.md

@@ -0,0 +1,13 @@
+## Index Models
+
+These are the models that describe indexes and the documents in them. `IndexInfo` and `IndexStats`
+are returned by the index information methods, the `Field` models describe how an attribute is
+configured, and `DocumentsInfo` is returned when getting multiple documents.
+
+## Index Models API
+
+::: meilisearch_python_sdk.models.index
+
+## Document Models API
+
+::: meilisearch_python_sdk.models.documents

meilisearch_python_sdk-7.5.2/docs/models_search.md

@@ -0,0 +1,10 @@
+## Search Models
+
+These are the models used by the search methods. `search` returns a `SearchResults` object,
+`facet_search` returns a `FacetSearchResults` object, and `search_similar_documents` returns a
+`SimilarSearchResults` object. `Hybrid`, `Personalize`, and the `Federation` models are passed
+into the search methods to control how the search is run.
+
+## Search Models API
+
+::: meilisearch_python_sdk.models.search

meilisearch_python_sdk-7.5.2/docs/models_settings.md

@@ -0,0 +1,10 @@
+## Settings Models
+
+These are the models used when getting and updating index settings. `MeilisearchSettings` holds
+all of the settings for an index and is what `get_settings` returns and `update_settings` accepts.
+The remaining models are the values used within it, for example the embedder models are used to
+configure vector search.
+
+## Settings Models API
+
+::: meilisearch_python_sdk.models.settings

meilisearch_python_sdk-7.5.2/docs/models_task.md

@@ -0,0 +1,14 @@
+## Task Models
+
+Meilisearch processes writes asynchronously, so methods that modify data return a `TaskInfo`
+rather than the result of the write. The `task_uid` from that `TaskInfo` can be used to look up
+a `TaskResult` to find out whether the write succeeded. Batches group the tasks Meilisearch
+processed together.
+
+## Task Models API
+
+::: meilisearch_python_sdk.models.task
+
+## Batch Models API
+
+::: meilisearch_python_sdk.models.batch

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/docs/plugins.md

@@ -313,3 +313,7 @@ def main() -> int:
 if __name__ == "__main__":
     raise SystemExit(main())
 ```
+
+## Plugins API
+
+::: meilisearch_python_sdk.plugins

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/meilisearch_python_sdk/_batch.py

@@ -41,7 +41,7 @@ async def async_get_batches(
     json_handler: JsonHandler,
     uids: list[int] | None = None,
     batch_uids: list[int] | None = None,
-    index_uids: list[int] | None = None,
+    index_uids: list[str] | None = None,
     statuses: list[str] | None = None,
     types: list[str] | None = None,
     limit: int = 20,
@@ -94,7 +94,7 @@ def get_batches(
     json_handler: JsonHandler,
     uids: list[int] | None = None,
     batch_uids: list[int] | None = None,
-    index_uids: list[int] | None = None,
+    index_uids: list[str] | None = None,
     statuses: list[str] | None = None,
     types: list[str] | None = None,
     limit: int = 20,
@@ -131,7 +131,7 @@ def _build_parameters(
     *,
     uids: list[int] | None = None,
     batch_uids: list[int] | None = None,
-    index_uids: list[int] | None = None,
+    index_uids: list[str] | None = None,
     statuses: list[str] | None = None,
     types: list[str] | None = None,
     limit: int = 20,

{meilisearch_python_sdk-7.5.0 → meilisearch_python_sdk-7.5.2}/meilisearch_python_sdk/_client/_async_client.py

@@ -895,7 +895,7 @@ class AsyncClient(BaseClient):
         *,
         uids: list[int] | None = None,
         batch_uids: list[int] | None = None,
-        index_uids: list[int] | None = None,
+        index_uids: list[str] | None = None,
         statuses: list[str] | None = None,
         types: list[str] | None = None,
         limit: int = 20,
@@ -927,7 +927,7 @@ class AsyncClient(BaseClient):
         self,
         *,
         uids: list[int] | None = None,
-        index_uids: list[int] | None = None,
+        index_uids: list[str] | None = None,
         statuses: list[str] | None = None,
         types: list[str] | None = None,
         before_enqueued_at: datetime | None = None,
@@ -1005,7 +1005,7 @@ class AsyncClient(BaseClient):
         self,
         *,
         uids: list[int] | None = None,
-        index_uids: list[int] | None = None,
+        index_uids: list[str] | None = None,
         statuses: list[str] | None = None,
         types: list[str] | None = None,
         before_enqueued_at: datetime | None = None,
@@ -1061,6 +1061,18 @@ class AsyncClient(BaseClient):
         index_ids: list[str] | None = None,
         types: str | list[str] | None = None,
         reverse: bool | None = None,
+        uids: list[int] | None = None,
+        batch_uids: list[int] | None = None,
+        canceled_by: list[int] | None = None,
+        statuses: str | list[str] | None = None,
+        before_enqueued_at: datetime | None = None,
+        after_enqueued_at: datetime | None = None,
+        before_started_at: datetime | None = None,
+        after_started_at: datetime | None = None,
+        before_finished_at: datetime | None = None,
+        after_finished_at: datetime | None = None,
+        limit: int | None = None,
+        from_: int | None = None,
     ) -> TaskStatus:
         """Get multiple tasks.
 
@@ -1069,6 +1081,24 @@ class AsyncClient(BaseClient):
                 tasks only for the specified indexes, if not all tasks will be returned. Default = None
             types: Specify specific task types to retrieve. Default = None
             reverse: If True the tasks will be returned in reverse order. Default = None
+            uids: A list of task UIDs to retrieve. Default = None
+            batch_uids: A list of batch UIDs for which to get the tasks. Default = None
+            canceled_by: A list of task UIDs that canceled the tasks to retrieve. Default = None
+            statuses: Specify specific task statuses to retrieve. Default = None
+            before_enqueued_at: Get tasks that were enqueued before the specified date time.
+                Default = None
+            after_enqueued_at: Get tasks that were enqueued after the specified date time.
+                Default = None
+            before_started_at: Get tasks that were started before the specified date time.
+                Default = None
+            after_started_at: Get tasks that were started after the specified date time.
+                Default = None
+            before_finished_at: Get tasks that were finished before the specified date time.
+                Default = None
+            after_finished_at: Get tasks that were finished after the specified date time.
+                Default = None
+            limit: The maximum number of tasks to return. Default = None
+            from_: The task UID from which to start returning tasks. Default = None
 
         Returns:
             Task statuses.
@@ -1090,6 +1120,18 @@ class AsyncClient(BaseClient):
             index_ids=index_ids,
             types=types,
             reverse=reverse,
+            uids=uids,
+            batch_uids=batch_uids,
+            canceled_by=canceled_by,
+            statuses=statuses,
+            before_enqueued_at=before_enqueued_at,
+            after_enqueued_at=after_enqueued_at,
+            before_started_at=before_started_at,
+            after_started_at=after_started_at,
+            before_finished_at=before_finished_at,
+            after_finished_at=after_finished_at,
+            limit=limit,
+            from_=from_,
         )
 
     async def wait_for_task(
@@ -1177,7 +1219,7 @@ class AsyncClient(BaseClient):
         """
         payload = build_transfer_documents_payload(url, api_key, payload_size, indexes)
 
-        response = await self._http_requests.post(url, body=payload)
+        response = await self._http_requests.post("export", body=payload)
 
         return TaskInfo(**self._http_requests.parse_json(response))