meilisearch-python-sdk 7.4.1__tar.gz → 7.5.1__tar.gz

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/.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.4.1 → meilisearch_python_sdk-7.5.1}/.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.4.1 → meilisearch_python_sdk-7.5.1}/.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.4.1 → meilisearch_python_sdk-7.5.1}/.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.4.1 → meilisearch_python_sdk-7.5.1}/.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
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v7
-      - uses: j178/prek-action@v2
+      - uses: j178/prek-action@v3.0.0
         env:
           PREK_SKIP: no-commit-to-branch,pyrefly-check
   parallel-testing:
@@ -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.4.1 → meilisearch_python_sdk-7.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: meilisearch-python-sdk
-Version: 7.4.1
+Version: 7.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
@@ -265,11 +265,6 @@ This test compares how long it takes to complete 1000 searches (lower is better)
 to be ~30% faster than the sync client for data ingestion. You can find a good write-up of the
 results how he tested them in his [blog post](https://thedataquarry.com/posts/meilisearch-async/).
 
-## Testing
-
-[pytest-meilisearch](https://github.com/sanders41/pytest-meilisearch) is a pytest plugin that can
-help with testing your code. It provides a lot of the boiler plate code you will need.
-
 ## Documentation
 
 See our [docs](https://meilisearch-python-sdk.paulsanders.dev) for the full documentation.

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/README.md

@@ -213,11 +213,6 @@ This test compares how long it takes to complete 1000 searches (lower is better)
 to be ~30% faster than the sync client for data ingestion. You can find a good write-up of the
 results how he tested them in his [blog post](https://thedataquarry.com/posts/meilisearch-async/).
 
-## Testing
-
-[pytest-meilisearch](https://github.com/sanders41/pytest-meilisearch) is a pytest plugin that can
-help with testing your code. It provides a lot of the boiler plate code you will need.
-
 ## Documentation
 
 See our [docs](https://meilisearch-python-sdk.paulsanders.dev) for the full documentation.

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/docker-compose.https.yml

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

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/docker-compose.yml

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

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/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.4.1 → meilisearch_python_sdk-7.5.1}/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.1/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.1/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.4.1 → meilisearch_python_sdk-7.5.1}/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.1/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.1/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.1/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.1/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.1/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.4.1 → meilisearch_python_sdk-7.5.1}/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.1/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/meilisearch_python_sdk/models/index.py

@@ -24,6 +24,8 @@ class IndexStats(CamelBase):
     is_indexing: bool
     field_distribution: dict[str, int]
     internal_database_sizes: JsonDict | None = None
+    index_size: int | str | None = None
+    used_index_size: int | str | None = None
 
 
 class FieldsFilter(CamelBase):

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/mkdocs.yaml

@@ -35,12 +35,31 @@ nav:
       - AsyncIndex: async_index_api.md
       - Index: index_api.md
       - Decorators: decorators_api.md
+      - Errors: errors_api.md
+  - Models:
+      - Search: models_search.md
+      - Settings: models_settings.md
+      - Index: models_index.md
+      - Tasks: models_task.md
+      - Client: models_client.md
   - Plugins: plugins.md
   - JSON Handler: json_handler.md
   - Pydantic: pydantic.md
 
 plugins:
-  - mkdocstrings
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_if_no_docstring: true
+            show_bases: true
+            show_signature_annotations: true
+            separate_signature: true
+            docstring_section_style: list
+            members_order: source
+            show_root_heading: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
   - search
 
 extra_javascript:

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/prek.toml

@@ -21,7 +21,7 @@ hooks = [
 
 [[repos]]
 repo = "https://github.com/facebook/pyrefly-pre-commit"
-rev = "1.1.1"
+rev = "1.2.0"
 hooks = [
   {
     id = "pyrefly-check",
@@ -34,7 +34,7 @@ hooks = [
 
 [[repos]]
 repo = "https://github.com/astral-sh/ruff-pre-commit"
-rev = "v0.16.0"
+rev = "v0.16.4"
 hooks = [
   {
     id = "ruff-check",
@@ -47,7 +47,7 @@ hooks = [
 
 [[repos]]
 repo = "https://github.com/rvben/rumdl-pre-commit"
-rev = "v0.2.45"
+rev = "v0.2.60"
 hooks = [
   { id = "rumdl-fmt" }
 ]

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/pyproject.toml

@@ -37,16 +37,16 @@ all = ["orjson"]
 [dependency-groups]
 dev = [
   "mkdocstrings[python]==1.0.6",
-  "pyrefly==1.1.1",
+  "pyrefly==1.2.0",
   "pytest==9.1.1",
   "pytest-cov==7.1.0",
   "pytest-asyncio==1.4.0",
   "pytest-xdist==3.8.0",
-  "prek==0.4.11",
-  "ruff==0.16.0",
+  "prek==0.4.14",
+  "ruff==0.16.4",
   "types-aiofiles==25.1.0.20260518",
   "typing-extensions==4.16.0",
-  "zensical==0.0.51",
+  "zensical==0.0.57",
 ]
 
 [tool.hatch.version]

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/tests/test_async_index.py

@@ -119,6 +119,8 @@ async def test_get_stats(async_empty_index, small_movies):
 
     assert response.number_of_documents == 30
     assert response.internal_database_sizes is None
+    assert response.index_size is not None
+    assert response.used_index_size is not None
 
 
 @pytest.mark.parametrize("size_format", (None, "raw", "human"))

{meilisearch_python_sdk-7.4.1 → meilisearch_python_sdk-7.5.1}/tests/test_index.py

@@ -111,6 +111,8 @@ def test_get_stats(empty_index, small_movies):
 
     assert response.number_of_documents == 30
     assert response.internal_database_sizes is None
+    assert response.index_size is not None
+    assert response.used_index_size is not None
 
 
 @pytest.mark.parametrize("size_format", (None, "raw", "human"))