# Meilisearch Python SDK
[](https://github.com/sanders41/meilisearch-python-sdk/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)
[](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-python-sdk/main)
[](https://codecov.io/gh/sanders41/meilisearch-python-sdk)
[](https://badge.fury.io/py/meilisearch-python-sdk)
[](https://github.com/sanders41/meilisearch-python-sdk)
NOTE: 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/), choose the `AsyncClient`,
otherwise choose the sync `Client`. The functionality of the two clients is the same, the difference
being that the `AsyncClient` provides async methods and uses the `AsyncIndex` with its own
additional async methods. On the other hand, `Client` provides blocking methods and uses the `Index`
with its own blocking methods.
## Installation
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
```
## Run Meilisearch
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 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
```
## Usage
### 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://www.meilisearch.com/docs/reference/api/tasks#status)
of the updates. To do this you would save the result response from adding the documents to a
variable, this will be an `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 it does not block the event loop,
the gains here will not be seen and the performance between the clients will be very similar.
### 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.
### Muiltiple Searches
This test compares how long it takes to complete 1000 searches (lower is better)
### 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/).
## 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.
## Contributing
Contributions to this project are welcome. If you are interested in contributing please see our
[contributing guide](CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/sanders41/meilisearch-python-sdk",
"name": "meilisearch-python-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "meilisearch,async,python,client,sdk",
"author": "Paul Sanders",
"author_email": "psanders1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f5/21/653cf9a782a3a5d73eae8d1e7b425815c77902c4a60fc444881c8e32861b/meilisearch_python_sdk-2.8.0.tar.gz",
"platform": null,
"description": "# Meilisearch Python SDK\n\n[](https://github.com/sanders41/meilisearch-python-sdk/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)\n[](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-python-sdk/main)\n[](https://codecov.io/gh/sanders41/meilisearch-python-sdk)\n[](https://badge.fury.io/py/meilisearch-python-sdk)\n[](https://github.com/sanders41/meilisearch-python-sdk)\n\nNOTE: This project was previously named `meilisearch-python-async`. Development on\nthat project continues here under the new name.\n\nMeilisearch Python SDK provides both an async and sync client for the\n[Meilisearch](https://github.com/meilisearch/meilisearch) API.\n\nWhich client to use depends on your use case. If the code base you are working with uses asyncio,\nfor example if you are using [FastAPI](https://fastapi.tiangolo.com/), choose the `AsyncClient`,\notherwise choose the sync `Client`. The functionality of the two clients is the same, the difference\nbeing that the `AsyncClient` provides async methods and uses the `AsyncIndex` with its own\nadditional async methods. On the other hand, `Client` provides blocking methods and uses the `Index`\nwith its own blocking methods.\n\n## Installation\n\nUsing a virtual environment is recommended for installing this package. Once the virtual\nenvironment is created and activated, install the package with:\n\n```sh\npip install meilisearch-python-sdk\n```\n\n## Run Meilisearch\n\nThere are several ways to\n[run Meilisearch](https://www.meilisearch.com/docs/learn/getting_started/installation).\nPick the one that works best for your use case and then start the server.\n\nAs as example to use Docker:\n\n```sh\ndocker pull getmeili/meilisearch:latest\ndocker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey\n```\n\n## Usage\n\n### Add Documents\n\n#### AsyncClient\n\n- Note: `client.index(\"books\") creates an instance of an AsyncIndex object but does not make a\n network call to send the data yet so it does not need to be awaited.\n\n```py\nfrom meilisearch_python_sdk import AsyncClient\n\nasync with AsyncClient('http://127.0.0.1:7700', 'masterKey') as client:\n index = client.index(\"books\")\n\n documents = [\n {\"id\": 1, \"title\": \"Ready Player One\"},\n {\"id\": 42, \"title\": \"The Hitchhiker's Guide to the Galaxy\"},\n ]\n\n await index.add_documents(documents)\n```\n\n#### Client\n\n```py\nfrom meilisearch_python_sdk import Client\n\nclient = Client('http://127.0.0.1:7700', 'masterKey')\nindex = client.index(\"books\")\n\ndocuments = [\n {\"id\": 1, \"title\": \"Ready Player One\"},\n {\"id\": 42, \"title\": \"The Hitchhiker's Guide to the Galaxy\"},\n]\n\nindex.add_documents(documents)\n```\n\nThe server will return an update id that can be used to\n[get the status](https://www.meilisearch.com/docs/reference/api/tasks#status)\nof the updates. To do this you would save the result response from adding the documents to a\nvariable, this will be an `UpdateId` object, and use it to check the status of the updates.\n\n#### AsyncClient\n\n```py\nupdate = await index.add_documents(documents)\nstatus = await client.index('books').get_update_status(update.update_id)\n```\n\n#### Client\n\n```py\nupdate = index.add_documents(documents)\nstatus = client.index('books').get_update_status(update.update_id)\n```\n\n### Basic Searching\n\n#### AsyncClient\n\n```py\nsearch_result = await index.search(\"ready player\")\n```\n\n#### Client\n\n```py\nsearch_result = index.search(\"ready player\")\n```\n\n### Base Search Results: SearchResults object with values\n\n```py\nSearchResults(\n hits = [\n {\n \"id\": 1,\n \"title\": \"Ready Player One\",\n },\n ],\n offset = 0,\n limit = 20,\n nb_hits = 1,\n exhaustive_nb_hits = bool,\n facets_distributionn = None,\n processing_time_ms = 1,\n query = \"ready player\",\n)\n```\n\n### Custom Search\n\nInformation about the parameters can be found in the\n[search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section\nof the documentation.\n\n#### AsyncClient\n\n```py\nawait index.search(\n \"guide\",\n attributes_to_highlight=[\"title\"],\n filters=\"book_id > 10\"\n)\n```\n\n#### Client\n\n```py\nindex.search(\n \"guide\",\n attributes_to_highlight=[\"title\"],\n filters=\"book_id > 10\"\n)\n```\n\n### Custom Search Results: SearchResults object with values\n\n```py\nSearchResults(\n hits = [\n {\n \"id\": 42,\n \"title\": \"The Hitchhiker's Guide to the Galaxy\",\n \"_formatted\": {\n \"id\": 42,\n \"title\": \"The Hitchhiker's Guide to the <em>Galaxy</em>\"\n }\n },\n ],\n offset = 0,\n limit = 20,\n nb_hits = 1,\n exhaustive_nb_hits = bool,\n facets_distributionn = None,\n processing_time_ms = 5,\n query = \"galaxy\",\n)\n```\n\n## Benchmark\n\nThe following benchmarks compare this library to the official\n[Meilisearch Python](https://github.com/meilisearch/meilisearch-python) library. Note that all\nof the performance gains seen with the `AsyncClient` are achieved by taking advantage of asyncio.\nThis means that if your code is not taking advantage of asyncio or it does not block the event loop,\nthe gains here will not be seen and the performance between the clients will be very similar.\n\n### Add Documents in Batches\n\nThis test compares how long it takes to send 1 million documents in batches of 1 thousand to the\nMeilisearch server for indexing (lower is better). The time does not take into account how long\nMeilisearch takes to index the documents since that is outside of the library functionality.\n\n\n\n### Muiltiple Searches\n\nThis test compares how long it takes to complete 1000 searches (lower is better)\n\n\n\n### Independent testing\n\n[Prashanth Rao](https://github.com/prrao87) did some independent testing and found this async client\nto be ~30% faster than the sync client for data ingestion. You can find a good write-up of the\nresults how he tested them in his [blog post](https://thedataquarry.com/posts/meilisearch-async/).\n\n## Testing\n\n[pytest-meilisearch](https://github.com/sanders41/pytest-meilisearch) is a pytest plugin that can\nhelp with testing your code. It provides a lot of the boiler plate code you will need.\n\n## Documentation\n\nSee our [docs](https://meilisearch-python-sdk.paulsanders.dev) for the full documentation.\n\n## Contributing\n\nContributions to this project are welcome. If you are interested in contributing please see our\n[contributing guide](CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python client providing both async and sync support for the Meilisearch API",
"version": "2.8.0",
"project_urls": {
"Documentation": "https://meilisearch-python-sdk.paulsanders.dev",
"Homepage": "https://github.com/sanders41/meilisearch-python-sdk",
"Repository": "https://github.com/sanders41/meilisearch-python-sdk"
},
"split_keywords": [
"meilisearch",
"async",
"python",
"client",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5005ae4dbfa1db6f216404454efa0c4701b9b486d6fa65ea4f4f3bd5a2f7171e",
"md5": "a9046d590e1df0343ede7fc773d474de",
"sha256": "c48a8b6de18247af64e66a66d091772a8d8bf11c7901efa15886966f72175e2a"
},
"downloads": -1,
"filename": "meilisearch_python_sdk-2.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9046d590e1df0343ede7fc773d474de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 51262,
"upload_time": "2024-03-11T11:32:41",
"upload_time_iso_8601": "2024-03-11T11:32:41.532461Z",
"url": "https://files.pythonhosted.org/packages/50/05/ae4dbfa1db6f216404454efa0c4701b9b486d6fa65ea4f4f3bd5a2f7171e/meilisearch_python_sdk-2.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f521653cf9a782a3a5d73eae8d1e7b425815c77902c4a60fc444881c8e32861b",
"md5": "8cf95753291f7d91eb94802b825f4098",
"sha256": "bd35f88d3df818940e06d81ce6d3348f85df003ea67095345b6707b7b0d58af5"
},
"downloads": -1,
"filename": "meilisearch_python_sdk-2.8.0.tar.gz",
"has_sig": false,
"md5_digest": "8cf95753291f7d91eb94802b825f4098",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 45583,
"upload_time": "2024-03-11T11:32:43",
"upload_time_iso_8601": "2024-03-11T11:32:43.088190Z",
"url": "https://files.pythonhosted.org/packages/f5/21/653cf9a782a3a5d73eae8d1e7b425815c77902c4a60fc444881c8e32861b/meilisearch_python_sdk-2.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-11 11:32:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sanders41",
"github_project": "meilisearch-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "meilisearch-python-sdk"
}
JSON
