You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<palign="center">⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Python</p>
23
+
<palign="center">⚡ The MeiliSearch API client written for Python 🐍</p>
24
24
25
-
**MeiliSearch Python** is a client for **MeiliSearch** written in Python. **MeiliSearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.
25
+
**MeiliSearch Python** is the MeiliSearch API client for Python developers. **MeiliSearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, facets, and synonyms are provided out-of-the-box.
26
26
27
27
## Table of Contents <!-- omit in toc -->
28
28
29
+
-[📖 Documentation](#-documentation)
29
30
-[🔧 Installation](#-installation)
30
31
-[🚀 Getting started](#-getting-started)
31
32
-[🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
32
-
-[📖 Documentation and Examples](#-documentation-and-examples)
33
+
-[� Learn More](#-learn-more)
33
34
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
34
35
36
+
## 📖 Documentation
37
+
38
+
See our [Documentation](https://docs.meilisearch.com/guides/introduction/quick_start_guide.html) or our [API References](https://docs.meilisearch.com/references/).
39
+
35
40
## 🔧 Installation
36
41
37
42
With `pip3` in command line:
@@ -45,6 +50,7 @@ $ pip3 install meilisearch
45
50
There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/guides/advanced_guides/installation.html#download-and-launch).
46
51
47
52
For example, if you use Docker:
53
+
48
54
```bash
49
55
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
50
56
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
With the `updateId`, you can check the status (`processed` or `failed`) of your documents addition thanks to this [method](https://docs.meilisearch.com/references/updates.html#get-an-update-status).
84
+
With the `updateId`, you can check the status (`enqueued`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/references/updates.html#get-an-update-status).
79
85
80
86
#### Basic Search <!-- omit in toc -->
81
87
@@ -85,6 +91,7 @@ index.search('harry pottre')
85
91
```
86
92
87
93
Output:
94
+
88
95
```python
89
96
{
90
97
"hits" => [{
@@ -106,12 +113,14 @@ All the supported options are described in the [search parameters](https://docs.
106
113
index.search(
107
114
'prince',
108
115
{
109
-
'limit': 1,
110
-
'attributesToHighlight': ['title']
116
+
'attributesToHighlight': ['title'],
117
+
'filters': ['book_id > 10']
111
118
}
112
119
)
113
120
```
114
121
122
+
JSON output:
123
+
115
124
```json
116
125
{
117
126
"hits": [
@@ -125,7 +134,7 @@ index.search(
125
134
}
126
135
],
127
136
"offset": 0,
128
-
"limit": 1,
137
+
"limit": 20,
129
138
"processingTimeMs": 10,
130
139
"query": "prince"
131
140
}
@@ -135,18 +144,14 @@ index.search(
135
144
136
145
This package only guarantees the compatibility with the [version v0.15.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.15.0).
137
146
138
-
## 📖 Documentation and Examples
139
-
140
-
MeiliSearch documentation provides **examples** and a detailed explanation of every one of its features and functionalities, including examples on how to implement them **using this SDK**.
141
-
142
-
Please read the [guides available in the documentation](https://docs.meilisearch.com/guides/) or check the [API references](https://docs.meilisearch.com/references/) to find the one that you need!
-[Manage the indexes](https://docs.meilisearch.com/references/indexes.html)
149
-
-[Configure the index settings](https://docs.meilisearch.com/references/settings.html)
151
+
-**Manipulate documents**: see the [API references](https://docs.meilisearch.com/references/documents.html) or read more about [documents](https://docs.meilisearch.com/guides/main_concepts/documents.html).
152
+
-**Search**: see the [API references](https://docs.meilisearch.com/references/search.html) or follow our guide on [search parameters](https://docs.meilisearch.com/guides/advanced_guides/search_parameters.html).
153
+
-**Manage the indexes**: see the [API references](https://docs.meilisearch.com/references/indexes.html) or read more about [indexes](https://docs.meilisearch.com/guides/main_concepts/indexes.html).
154
+
-**Configure the index settings**: see the [API references](https://docs.meilisearch.com/references/settings.html) or follow our guide on [settings parameters](https://docs.meilisearch.com/guides/advanced_guides/settings.html).
0 commit comments