meilisearch-python-sdk 5.1.0__tar.gz → 5.3.0__tar.gz

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.0
+    rev: v0.14.2
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/CONTRIBUTING.md

@@ -164,7 +164,7 @@ Now with the container running, run the test suite
 uv run pytest
 ```
 
-In additon to mainting the coverage percentage please ensure that all
+In addition to mainting the coverage percentage please ensure that all
 tests are passing before submitting a pull request.
 
 #### just
@@ -288,7 +288,7 @@ git fetch upstream
 git rebase upstream/main
 ```
 
-There may be some merge conficts that need to be resolved. After the feature branch has been update
+There may be some merge conflicts that need to be resolved. After the feature branch has been update
 locally, you can now update your pull request by pushing to the branch on GitHub:
 
 ```sh

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 5.1.0
+Version: 5.3.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
@@ -122,15 +122,15 @@ async with AsyncClient('http://127.0.0.1:7700', 'masterKey') as client:
 ```py
 from meilisearch_python_sdk import Client
 
-client = Client('http://127.0.0.1:7700', 'masterKey')
-index = client.index("books")
+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"},
-]
+    documents = [
+        {"id": 1, "title": "Ready Player One"},
+        {"id": 42, "title": "The Hitchhiker's Guide to the Galaxy"},
+    ]
 
-index.add_documents(documents)
+    index.add_documents(documents)
 ```
 
 The server will return an update id that can be used to
@@ -252,7 +252,7 @@ Meilisearch takes to index the documents since that is outside of the library fu
 
 ![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/add_in_batches.png)
 
-### Muiltiple Searches
+### Multiple Searches
 
 This test compares how long it takes to complete 1000 searches (lower is better)
 

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/README.md

@@ -66,15 +66,15 @@ async with AsyncClient('http://127.0.0.1:7700', 'masterKey') as client:
 ```py
 from meilisearch_python_sdk import Client
 
-client = Client('http://127.0.0.1:7700', 'masterKey')
-index = client.index("books")
+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"},
-]
+    documents = [
+        {"id": 1, "title": "Ready Player One"},
+        {"id": 42, "title": "The Hitchhiker's Guide to the Galaxy"},
+    ]
 
-index.add_documents(documents)
+    index.add_documents(documents)
 ```
 
 The server will return an update id that can be used to
@@ -196,7 +196,7 @@ Meilisearch takes to index the documents since that is outside of the library fu
 
 ![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/add_in_batches.png)
 
-### Muiltiple Searches
+### Multiple Searches
 
 This test compares how long it takes to complete 1000 searches (lower is better)
 

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/docs/async_index_api.md

@@ -1,6 +1,6 @@
 ## `AsyncIndex` Usage
 
-The `AsyncIndex` is the the same as the `Index`, but gives asyncronous methods to work with, and
+The `AsyncIndex` is the the same as the `Index`, but gives asynchronous methods to work with, and
 and should be used when using the `AsyncClient`. When you create a new index with the `AsyncClient`
 it will create an `AsyncIndex` instance.
 

meilisearch_python_sdk-5.3.0/docs/client_api.md

@@ -0,0 +1,53 @@
+## `client` Usage
+
+### Create a client with a context manager
+
+This client runs in a context manager which ensures that everything is cleaned up after the use of
+the client is done. To create a client:
+
+```py
+from meilisearch-python-sdk import Client
+
+
+with Client("http://localhost:7700", "masterKey") as client:
+    index = client.index("movies")
+    ...
+```
+
+### Custom headers
+
+Custom headers can be added to the client by adding them to `custom_headers` when creating the
+client.
+
+```py
+from meilisearch_python_sdk import Client
+
+with Client(
+    "http://127.0.0.1:7700",
+    "masterKey",
+    custom_headers={"header_key_1": "header_value_1", "header_key_2": "header_value_2"}
+) as client:
+    index = client.index("movies")
+...
+```
+
+### Create a client without a context manager
+
+It is also possible to call the client without using a context manager, but in doing so you will
+need to make sure to do the cleanup yourself:
+
+```py
+from meilisearch-python-sdk import Client
+
+
+try:
+    client = Client("http://localhost:7700", "masterKey")
+    ...
+finally:
+    await client.close()
+
+```
+
+## `Client` API
+
+::: meilisearch_python_sdk.Client

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/docs/json_handler.md

@@ -1,6 +1,6 @@
 # JSON Handler
 
-For json loads and dumps you have the option to use the `json` module from the standard libary,
+For json loads and dumps you have the option to use the `json` module from the standard library,
 orjson, or ujson. This done by setting the `json_handler` when creating the `AsyncClient` or
 `Client`. By default the standard library `json` module will be used. The examples below use
 `Client`, and the same options are available for `AsyncClient`.
@@ -37,9 +37,9 @@ documents = [
     {"id": uuid4(), "title": "test 1", "when": datetime.now()},
     {"id": uuid4(), "title": "Test 2", "when": datetime.now()},
 ]
-client = Client("http://127.0.0.1:7700", json_handler=BuiltinHandler(serializer=CustomEncoder))
-index = client.index("movies", primary_key="id")
-index.add_documents(documents)
+with Client("http://127.0.0.1:7700", json_handler=BuiltinHandler(serializer=CustomEncoder)) as client:
+    index = client.index("movies", primary_key="id")
+    index.add_documents(documents)
 ```
 
 ## orjson
@@ -57,9 +57,9 @@ documents = [
     {"id": uuid4(), "title": "test 1"},
     {"id": uuid4(), "title": "Test 2"},
 ]
-client = Client("http://127.0.0.1:7700", json_handler=OrjsonHandler())
-index = client.index("movies", primary_key="id")
-index.add_documents(documents)
+with Client("http://127.0.0.1:7700", json_handler=OrjsonHandler()) as client:
+    index = client.index("movies", primary_key="id")
+    index.add_documents(documents)
 ```
 
 ## ujson
@@ -77,7 +77,7 @@ documents = [
     {"id": uuid4(), "title": "test 1"},
     {"id": uuid4(), "title": "Test 2"},
 ]
-client = Client("http://127.0.0.1:7700", json_handler=UjsonHandler())
-index = client.index("movies", primary_key="id")
-index.add_documents(documents)
+with Client("http://127.0.0.1:7700", json_handler=UjsonHandler()) as client:
+    index = client.index("movies", primary_key="id")
+    index.add_documents(documents)
 ```

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/docs/plugins.md

@@ -15,7 +15,7 @@ is done through a named tuple that specifies where the plugin should run. The op
 - update_documents_plugins: Run on the `update_document` method.
 
 When creating your plugin you specify if you want it to run before or after the default
-functionality. Additionaly plugins for async indexes can be run concurrently with the default
+functionality. Additionally plugins for async indexes can be run concurrently with the default
 functionality.
 
 ## Examples:
@@ -27,9 +27,9 @@ way to track this out of the box. A search plugin could be used to implement thi
 yourself.
 
 Note that in these examples the protocol is satisfied by providing the `CONNECURRENT_EVENT`,
-`POST_EVENT`, and `PRE_EVENT` vairables and the
+`POST_EVENT`, and `PRE_EVENT` variables and the
 `async def run_plugin(self, event: AsyncEvent, **kwargs: Any) -> None:` method for an async index,
-or the `POST_EVENT` and `PRE_EVENT` vairables , and
+or the `POST_EVENT` and `PRE_EVENT` variables , and
 `def run_plugin(self, event: Event, **kwargs: Any) -> None:` method for a non-async index. You
 class can contain any additional methods/variables needed as long as the protocol requirements
 have been satisfied.
@@ -84,13 +84,13 @@ async def main() -> int:
     with open("datasets/small_movies.json") as f:
         documents = json.load(f)
 
-    client = AsyncClient("http://127.0.0.1:7700", "masterKey")
-    plugins = AsyncIndexPlugins(search_plugins=(SearchTrackerPlugin(),))
-    index = await client.create_index("movies", primary_key="id", plugins=plugins)
-    task = await index.add_documents(documents)
-    await client.wait_for_task(task.task_uid)
-    result = await index.search("Cars")
-    print(result)  # noqa: T201
+    async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        plugins = AsyncIndexPlugins(search_plugins=(SearchTrackerPlugin(),))
+        index = await client.create_index("movies", primary_key="id", plugins=plugins)
+        task = await index.add_documents(documents)
+        await client.wait_for_task(task.task_uid)
+        result = await index.search("Cars")
+        print(result)  # noqa: T201
 
     return 0
 
@@ -142,13 +142,13 @@ def main() -> int:
     with open("datasets/small_movies.json") as f:
         documents = json.load(f)
 
-    client = Client("http://127.0.0.1:7700", "masterKey")
-    plugins = IndexPlugins(search_plugins=(SearchTrackerPlugin(),))
-    index = client.create_index("movies", primary_key="id", plugins=plugins)
-    task = index.add_documents(documents)
-    client.wait_for_task(task.task_uid)
-    result = index.search("Cars")
-    print(result)  # noqa: T201
+    with Client("http://127.0.0.1:7700", "masterKey") as client:
+        plugins = IndexPlugins(search_plugins=(SearchTrackerPlugin(),))
+        index = client.create_index("movies", primary_key="id", plugins=plugins)
+        task = index.add_documents(documents)
+        client.wait_for_task(task.task_uid)
+        result = index.search("Cars")
+        print(result)  # noqa: T201
 
     return 0
 
@@ -160,12 +160,12 @@ if __name__ == "__main__":
 ### Modify documents and search results
 
 A pre event plugin can be used to modify the documents before sending for indexing. In this example
-a new `access` field will be added to the doocuments before they are added or updated. The example
+a new `access` field will be added to the documents before they are added or updated. The example
 will set every other record to `admin` access with the other records being set to `read`. This will
-illustrate the idea of modifing documents even it if doesn't make real world sense.
+illustrate the idea of modifying documents even it if doesn't make real world sense.
 
 A post search plugin, this type of search plugin can only be used post search because it requires
-the result of the search, will be used to remove records marked as `admin` before returing the result.
+the result of the search, will be used to remove records marked as `admin` before returning the result.
 In the real world this filtering would probably be done with a filterable field in Meilisearch,but
 again, this is just used here to illustrate the idea.
 
@@ -224,17 +224,17 @@ async def main() -> int:
     with open("datasets/small_movies.json") as f:
         documents = json.load(f)
 
-    client = AsyncClient("http://127.0.0.1:7700", "masterKey")
-    plugins = AsyncIndexPlugins(
-        add_documents_plugins=(ModifyDocumentPlugin(),),
-        update_documents_plugins=(ModifyDocumentPlugin(),),
-        search_plugins=(FilterSearchResultsPlugin(),),
-    )
-    index = await client.create_index("movies", primary_key="id", plugins=plugins)
-    task = await index.add_documents(documents)
-    await client.wait_for_task(task.task_uid)
-    result = await index.search("cars")
-    print(result)  # noqa: T201
+    async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        plugins = AsyncIndexPlugins(
+            add_documents_plugins=(ModifyDocumentPlugin(),),
+            update_documents_plugins=(ModifyDocumentPlugin(),),
+            search_plugins=(FilterSearchResultsPlugin(),),
+        )
+        index = await client.create_index("movies", primary_key="id", plugins=plugins)
+        task = await index.add_documents(documents)
+        await client.wait_for_task(task.task_uid)
+        result = await index.search("cars")
+        print(result)  # noqa: T201
 
     return 0
 
@@ -295,17 +295,17 @@ def main() -> int:
     with open("datasets/small_movies.json") as f:
         documents = json.load(f)
 
-    client = Client("http://127.0.0.1:7700", "masterKey")
-    plugins = IndexPlugins(
-        add_documents_plugins=(ModifyDocumentPlugin(),),
-        update_documents_plugins=(ModifyDocumentPlugin(),),
-        search_plugins=(FilterSearchResultsPlugin(),),
-    )
-    index = client.create_index("movies", primary_key="id", plugins=plugins)
-    task = index.add_documents(documents)
-    client.wait_for_task(task.task_uid)
-    result = index.search("cars")
-    print(result)  # noqa: T201
+    with Client("http://127.0.0.1:7700", "masterKey") as client:
+        plugins = IndexPlugins(
+            add_documents_plugins=(ModifyDocumentPlugin(),),
+            update_documents_plugins=(ModifyDocumentPlugin(),),
+            search_plugins=(FilterSearchResultsPlugin(),),
+        )
+        index = client.create_index("movies", primary_key="id", plugins=plugins)
+        task = index.add_documents(documents)
+        client.wait_for_task(task.task_uid)
+        result = index.search("cars")
+        print(result)  # noqa: T201
 
     return 0
 

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/docs/pydantic.md

@@ -55,7 +55,7 @@ Movie(
 ```
 
 By inheriting from CamelBase, or any of the other [provided models](https://github.com/sanders41/meilisearch-python-sdk/tree/main/meilisearch_python_sdk/models)
-you will be inheriting Pydantic models and therefore have access to the funcitonality Pydantic provides
+you will be inheriting Pydantic models and therefore have access to the functionality Pydantic provides
 such as [validators](https://pydantic-docs.helpmanual.io/usage/validators/) and [Fields](https://pydantic-docs.helpmanual.io/usage/model_config/#alias-precedence).
 Pydantic will also automatically deserialized the data into the correct data type based on the type
 hint provided.

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/examples/add_documents_decorator.py

@@ -19,12 +19,12 @@ def load_documents() -> list[dict[str, Any]]:
 
 
 def main() -> int:
-    client = Client("http://127.0.0.1:7700", "masterKey")
-    index = client.create_index("movies", "id")
-    load_documents()
-    documents = index.get_documents()
+    with Client("http://127.0.0.1:7700", "masterKey") as client:
+        index = client.create_index("movies", "id")
+        load_documents()
+        documents = index.get_documents()
 
-    print(documents)  # noqa: T201
+        print(documents)  # noqa: T201
 
     return 0
 

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/examples/add_documents_in_batches.py

@@ -9,11 +9,11 @@ def main() -> int:
     with open("../datasets/small_movies.json") as f:
         documents = json.load(f)
 
-    client = Client("http://127.0.0.1:7700", "masterKey")
-    index = client.index("movies")
+    with Client("http://127.0.0.1:7700", "masterKey") as client:
+        index = client.index("movies")
 
-    # Meilisearch prefers larger batch sizes so set this as large as you can.
-    index.add_documents_in_batches(documents, primary_key="id", batch_size=1000)
+        # Meilisearch prefers larger batch sizes so set this as large as you can.
+        index.add_documents_in_batches(documents, primary_key="id", batch_size=1000)
 
     return 0
 

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/examples/documents_and_search_results.py

@@ -50,17 +50,17 @@ def main() -> int:
     with open("../datasets/small_movies.json") as f:
         documents = json.load(f)
 
-    client = Client("http://127.0.0.1:7700", "masterKey")
-    plugins = IndexPlugins(
-        add_documents_plugins=(ModifyDocumentPlugin(),),
-        update_documents_plugins=(ModifyDocumentPlugin(),),
-        search_plugins=(FilterSearchResultsPlugin(),),
-    )
-    index = client.create_index("movies", primary_key="id", plugins=plugins)
-    task = index.add_documents(documents)
-    client.wait_for_task(task.task_uid)
-    result = index.search("cars")
-    print(result)  # noqa: T201
+    with Client("http://127.0.0.1:7700", "masterKey") as client:
+        plugins = IndexPlugins(
+            add_documents_plugins=(ModifyDocumentPlugin(),),
+            update_documents_plugins=(ModifyDocumentPlugin(),),
+            search_plugins=(FilterSearchResultsPlugin(),),
+        )
+        index = client.create_index("movies", primary_key="id", plugins=plugins)
+        task = index.add_documents(documents)
+        client.wait_for_task(task.task_uid)
+        result = index.search("cars")
+        print(result)  # noqa: T201
 
     return 0
 

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/examples/orjson_example.py

@@ -8,9 +8,9 @@ from meilisearch_python_sdk.models.task import TaskInfo
 
 
 def add_documents(file_path: Path | str = "../datasets/small_movies.json") -> TaskInfo:
-    client = Client("http://127.0.0.1:7700", "masterKey", json_handler=OrjsonHandler())
-    index = client.create_index("movies", primary_key="id")
-    return index.add_documents_from_file(file_path)
+    with Client("http://127.0.0.1:7700", "masterKey", json_handler=OrjsonHandler()) as client:
+        index = client.create_index("movies", primary_key="id")
+        return index.add_documents_from_file(file_path)
 
 
 def main() -> int:

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/examples/search_tracker.py

@@ -53,13 +53,13 @@ def search(index: Index, query: str) -> SearchResults[JsonDict]:
 
 
 def main() -> int:
-    client = Client("http://127.0.0.1:7700", "masterKey")
-    plugins = IndexPlugins(search_plugins=(SearchTrackerPlugin(),))
-    index = client.create_index("movies", primary_key="id", plugins=plugins)
-    task = add_documents(index)
-    client.wait_for_task(task.task_uid)
-    result = search(index, "Cars")
-    print(result)  # noqa: T201
+    with Client("http://127.0.0.1:7700", "masterKey") as client:
+        plugins = IndexPlugins(search_plugins=(SearchTrackerPlugin(),))
+        index = client.create_index("movies", primary_key="id", plugins=plugins)
+        task = add_documents(index)
+        client.wait_for_task(task.task_uid)
+        result = search(index, "Cars")
+        print(result)  # noqa: T201
 
     return 0
 

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/examples/ujson_example.py

@@ -8,9 +8,9 @@ from meilisearch_python_sdk.models.task import TaskInfo
 
 
 def add_documents(file_path: Path | str = "../datasets/small_movies.json") -> TaskInfo:
-    client = Client("http://127.0.0.1:7700", "masterKey", json_handler=UjsonHandler())
-    index = client.create_index("movies", primary_key="id")
-    return index.add_documents_from_file(file_path)
+    with Client("http://127.0.0.1:7700", "masterKey", json_handler=UjsonHandler()) as client:
+        index = client.create_index("movies", primary_key="id")
+        return index.add_documents_from_file(file_path)
 
 
 def main() -> int:

{meilisearch_python_sdk-5.1.0 → meilisearch_python_sdk-5.3.0}/examples/update_settings.py

@@ -25,11 +25,11 @@ def update_settings(index: Index) -> TaskInfo:
 
 
 def main() -> int:
-    client = Client("http://127.0.0.1:7700", "masterKey")
-    index = client.create_index("movies", primary_key="id")
-    task = update_settings(index)
-    client.wait_for_task(task.task_uid)
-    add_documents(index)
+    with Client("http://127.0.0.1:7700", "masterKey") as client:
+        index = client.create_index("movies", primary_key="id")
+        task = update_settings(index)
+        client.wait_for_task(task.task_uid)
+        add_documents(index)
 
     return 0