meilisearch-python-sdk 2.0.0__tar.gz

meilisearch_python_sdk-2.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Paul Sanders
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

meilisearch_python_sdk-2.0.0/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.1
+Name: meilisearch-python-sdk
+Version: 2.0.0
+Summary: A Python async client for the Meilisearch API
+Home-page: https://github.com/sanders41/meilisearch-python-sdk
+License: MIT
+Keywords: meilisearch,async,python,client,sdk
+Author: Paul Sanders
+Author-email: psanders1@gmail.com
+Requires-Python: >=3.8,<4.0
+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
+Classifier: Programming Language :: Python :: 3.8
+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: Typing :: Typed
+Requires-Dist: PyJWT (>=2.3.0)
+Requires-Dist: aiofiles (>=0.7)
+Requires-Dist: camel-converter (>=1.0.0)
+Requires-Dist: httpx (>=0.17)
+Requires-Dist: pydantic (>=1.8)
+Project-URL: Documentation, https://meilisearch-python-sdk.paulsanders.dev
+Project-URL: Repository, https://github.com/sanders41/meilisearch-python-sdk
+Description-Content-Type: text/markdown
+
+# Meilisearch Python SDK
+
+[![Tests Status](https://github.com/sanders41/meilisearch-python-sdk/workflows/Testing/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)
+
+:warning: This project was previously named `meilisearch-python-async`. Development on that project
+continues here under the new name.
+
+Meilisearch Python SDK provides both an async and sync client for the
+[Meilisearch](https://github.com/meilisearch/meilisearch) API.
+
+Which client to use depends on your use case. 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.
+
+## Installation
+
+Using a virtual environmnet is recommended for installing this package. Once the virtual
+environment is created and activated install the package with:
+
+```sh
+pip install meilisearch-python-sdk
+```
+
+## Run Meilisearch
+
+There are several ways to
+[run Meilisearch](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+Pick the one that works best for your use case and then start the server.
+
+As as example to use Docker:
+
+```sh
+docker pull getmeili/meilisearch:latest
+docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
+```
+
+## Useage
+
+### Add Documents
+
+
+#### AsyncClient
+
+- Note: `client.index("books") creates an instance of an AsyncIndex object but does not make a
+network call to send the data yet so it does not need to be awaited.
+
+```py
+from meilisearch_python_sdk import AsyncClient
+
+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"},
+    ]
+
+    await index.add_documents(documents)
+```
+
+#### Client
+
+```py
+from meilisearch_python_sdk import Client
+
+client = Client('http://127.0.0.1:7700', 'masterKey')
+index = client.index("books")
+
+documents = [
+    {"id": 1, "title": "Ready Player One"},
+    {"id": 42, "title": "The Hitchhiker's Guide to the Galaxy"},
+]
+
+index.add_documents(documents)
+```
+
+The server will return an update id that can be used to
+[get the status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status)
+of the updates. To do this you would save the result response from adding the documets to a
+variable, this will be a UpdateId object, and use it to check the status of the updates.
+
+#### AsyncClient
+
+```py
+update = await index.add_documents(documents)
+status = await client.index('books').get_update_status(update.update_id)
+```
+
+#### Client
+
+```py
+update = index.add_documents(documents)
+status = client.index('books').get_update_status(update.update_id)
+```
+
+### Basic Searching
+
+#### AsyncClient
+
+```py
+search_result = await index.search("ready player")
+```
+
+#### Client
+
+```py
+search_result = index.search("ready player")
+```
+
+### Base Search Results: SearchResults object with values
+
+```py
+SearchResults(
+    hits = [
+        {
+            "id": 1,
+            "title": "Ready Player One",
+        },
+    ],
+    offset = 0,
+    limit = 20,
+    nb_hits = 1,
+    exhaustive_nb_hits = bool,
+    facets_distributionn = None,
+    processing_time_ms = 1,
+    query = "ready player",
+)
+```
+
+### Custom Search
+
+Information about the parameters can be found in the
+[search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section
+of the documentation.
+
+#### AsyncClient
+
+```py
+await index.search(
+    "guide",
+    attributes_to_highlight=["title"],
+    filters="book_id > 10"
+)
+```
+
+#### Client
+
+```py
+index.search(
+    "guide",
+    attributes_to_highlight=["title"],
+    filters="book_id > 10"
+)
+```
+
+### Custom Search Results: SearchResults object with values
+
+```py
+SearchResults(
+    hits = [
+        {
+            "id": 42,
+            "title": "The Hitchhiker's Guide to the Galaxy",
+            "_formatted": {
+                "id": 42,
+                "title": "The Hitchhiker's Guide to the <em>Galaxy</em>"
+            }
+        },
+    ],
+    offset = 0,
+    limit = 20,
+    nb_hits = 1,
+    exhaustive_nb_hits = bool,
+    facets_distributionn = None,
+    processing_time_ms = 5,
+    query = "galaxy",
+)
+```
+
+## Benchmark
+
+The following benchmarks compare this library to the official
+[Meilisearch Python](https://github.com/meilisearch/meilisearch-python) library. Note that all
+of the performance gains seen with the `AsyncClient` are achieved by taking advantage of asyncio.
+This means that if your code is not taking advantage of asyncio or blocking the event loop the
+gains here will not be seen and the performance between the clients will be very close to the same.
+
+### Add Documents in Batches
+
+This test compares how long it takes to send 1 million documents in batches of 1 thousand to the
+Meilisearch server for indexing (lower is better). The time does not take into account how long
+Meilisearch takes to index the documents since that is outside of the library functionality.
+
+![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/add_in_batches.png)
+
+### Muiltiple Searches
+
+This test compares how long it takes to complete 1000 searches (lower is better)
+
+![Multiple Searches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/searches.png)
+
+### Independent testing
+
+[Prashanth Rao](https://github.com/prrao87) did some independent testing and found this async client
+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/).
+
+## Documentation
+
+See our [docs](https://meilisearch-python-sdk.paulsanders.dev) for the full documentation.
+
+## Contributing
+
+Contributions to this project are welcome. If you are interested in contributing please see our
+[contributing guide](CONTRIBUTING.md)
+

meilisearch_python_sdk-2.0.0/README.md

@@ -0,0 +1,222 @@
+# Meilisearch Python SDK
+
+[![Tests Status](https://github.com/sanders41/meilisearch-python-sdk/workflows/Testing/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)
+
+:warning: This project was previously named `meilisearch-python-async`. Development on that project
+continues here under the new name.
+
+Meilisearch Python SDK provides both an async and sync client for the
+[Meilisearch](https://github.com/meilisearch/meilisearch) API.
+
+Which client to use depends on your use case. 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.
+
+## Installation
+
+Using a virtual environmnet is recommended for installing this package. Once the virtual
+environment is created and activated install the package with:
+
+```sh
+pip install meilisearch-python-sdk
+```
+
+## Run Meilisearch
+
+There are several ways to
+[run Meilisearch](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+Pick the one that works best for your use case and then start the server.
+
+As as example to use Docker:
+
+```sh
+docker pull getmeili/meilisearch:latest
+docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
+```
+
+## Useage
+
+### Add Documents
+
+
+#### AsyncClient
+
+- Note: `client.index("books") creates an instance of an AsyncIndex object but does not make a
+network call to send the data yet so it does not need to be awaited.
+
+```py
+from meilisearch_python_sdk import AsyncClient
+
+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"},
+    ]
+
+    await index.add_documents(documents)
+```
+
+#### Client
+
+```py
+from meilisearch_python_sdk import Client
+
+client = Client('http://127.0.0.1:7700', 'masterKey')
+index = client.index("books")
+
+documents = [
+    {"id": 1, "title": "Ready Player One"},
+    {"id": 42, "title": "The Hitchhiker's Guide to the Galaxy"},
+]
+
+index.add_documents(documents)
+```
+
+The server will return an update id that can be used to
+[get the status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status)
+of the updates. To do this you would save the result response from adding the documets to a
+variable, this will be a UpdateId object, and use it to check the status of the updates.
+
+#### AsyncClient
+
+```py
+update = await index.add_documents(documents)
+status = await client.index('books').get_update_status(update.update_id)
+```
+
+#### Client
+
+```py
+update = index.add_documents(documents)
+status = client.index('books').get_update_status(update.update_id)
+```
+
+### Basic Searching
+
+#### AsyncClient
+
+```py
+search_result = await index.search("ready player")
+```
+
+#### Client
+
+```py
+search_result = index.search("ready player")
+```
+
+### Base Search Results: SearchResults object with values
+
+```py
+SearchResults(
+    hits = [
+        {
+            "id": 1,
+            "title": "Ready Player One",
+        },
+    ],
+    offset = 0,
+    limit = 20,
+    nb_hits = 1,
+    exhaustive_nb_hits = bool,
+    facets_distributionn = None,
+    processing_time_ms = 1,
+    query = "ready player",
+)
+```
+
+### Custom Search
+
+Information about the parameters can be found in the
+[search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section
+of the documentation.
+
+#### AsyncClient
+
+```py
+await index.search(
+    "guide",
+    attributes_to_highlight=["title"],
+    filters="book_id > 10"
+)
+```
+
+#### Client
+
+```py
+index.search(
+    "guide",
+    attributes_to_highlight=["title"],
+    filters="book_id > 10"
+)
+```
+
+### Custom Search Results: SearchResults object with values
+
+```py
+SearchResults(
+    hits = [
+        {
+            "id": 42,
+            "title": "The Hitchhiker's Guide to the Galaxy",
+            "_formatted": {
+                "id": 42,
+                "title": "The Hitchhiker's Guide to the <em>Galaxy</em>"
+            }
+        },
+    ],
+    offset = 0,
+    limit = 20,
+    nb_hits = 1,
+    exhaustive_nb_hits = bool,
+    facets_distributionn = None,
+    processing_time_ms = 5,
+    query = "galaxy",
+)
+```
+
+## Benchmark
+
+The following benchmarks compare this library to the official
+[Meilisearch Python](https://github.com/meilisearch/meilisearch-python) library. Note that all
+of the performance gains seen with the `AsyncClient` are achieved by taking advantage of asyncio.
+This means that if your code is not taking advantage of asyncio or blocking the event loop the
+gains here will not be seen and the performance between the clients will be very close to the same.
+
+### Add Documents in Batches
+
+This test compares how long it takes to send 1 million documents in batches of 1 thousand to the
+Meilisearch server for indexing (lower is better). The time does not take into account how long
+Meilisearch takes to index the documents since that is outside of the library functionality.
+
+![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/add_in_batches.png)
+
+### Muiltiple Searches
+
+This test compares how long it takes to complete 1000 searches (lower is better)
+
+![Multiple Searches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/searches.png)
+
+### Independent testing
+
+[Prashanth Rao](https://github.com/prrao87) did some independent testing and found this async client
+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/).
+
+## Documentation
+
+See our [docs](https://meilisearch-python-sdk.paulsanders.dev) for the full documentation.
+
+## Contributing
+
+Contributions to this project are welcome. If you are interested in contributing please see our
+[contributing guide](CONTRIBUTING.md)

meilisearch_python_sdk-2.0.0/meilisearch_python_sdk/__init__.py

@@ -0,0 +1,8 @@
+from meilisearch_python_sdk._client import AsyncClient, Client
+from meilisearch_python_sdk._index import AsyncIndex, Index
+from meilisearch_python_sdk._version import VERSION
+
+__version__ = VERSION
+
+
+__all__ = ["AsyncClient", "AsyncIndex", "Client", "Index"]