Skip to content

Commit 089efce

Browse files
Update README [skip ci]
1 parent 1a67271 commit 089efce

File tree

1 file changed

+72
-53
lines changed

1 file changed

+72
-53
lines changed

README.md

Lines changed: 72 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Algolia Search API Client for Python
22

3-
[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
4-
The **Algolia Search API Client for Python** lets you easily use the [Algolia Search REST API](https://www.algolia.com/doc/rest-api/search) from your Python code.
3+
[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical,
4+
and faceted search engine capable of delivering realtime results from the first keystroke.
5+
6+
The **Algolia Search API Client for Python** lets
7+
you easily use the [Algolia Search REST API](https://www.algolia.com/doc/rest-api/search) from
8+
your Python code.
59

610
[![Build Status](https://travis-ci.org/algolia/algoliasearch-client-python.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-client-python) [![PyPI version](https://badge.fury.io/py/algoliasearch.svg?branch=master)](http://badge.fury.io/py/algoliasearch) [![Coverage Status](https://coveralls.io/repos/algolia/algoliasearch-client-python/badge.svg?branch=master)](https://coveralls.io/r/algolia/algoliasearch-client-python)
711

@@ -27,7 +31,6 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
2731

2832
1. **[Quick Start](#quick-start)**
2933

30-
* [Initialize the client](#initialize-the-client)
3134

3235
1. **[Push data](#push-data)**
3336

@@ -40,18 +43,14 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
4043

4144
1. **[Search UI](#search-ui)**
4245

43-
* [index.html](#indexhtml)
4446

4547
1. **[List of available methods](#list-of-available-methods)**
4648

4749

48-
49-
5050
# Getting Started
5151

5252

5353

54-
5554
## Install
5655

5756
Install AlgoliaSearch using pip:
@@ -203,93 +202,114 @@ search.start();
203202

204203

205204

205+
206+
206207
### Search
207208

208-
- [Search an index](https://algolia.com/doc/api-reference/api-methods/search/?language=python)
209-
- [Search for facet values](https://algolia.com/doc/api-reference/api-methods/search-for-facet-values/?language=python)
210-
- [Search multiple indexes](https://algolia.com/doc/api-reference/api-methods/multiple-queries/?language=python)
211-
- [Browse an index](https://algolia.com/doc/api-reference/api-methods/browse/?language=python)
209+
- [Search an index](https://algolia.com/doc/api-reference/api-methods/search/?language=python)
210+
- [Search for facet values](https://algolia.com/doc/api-reference/api-methods/search-for-facet-values/?language=python)
211+
- [Search multiple indexes](https://algolia.com/doc/api-reference/api-methods/multiple-queries/?language=python)
212+
- [Browse an index](https://algolia.com/doc/api-reference/api-methods/browse/?language=python)
213+
214+
212215

213216

214217

215218
### Indexing
216219

217-
- [Add objects](https://algolia.com/doc/api-reference/api-methods/add-objects/?language=python)
218-
- [Update objects](https://algolia.com/doc/api-reference/api-methods/update-objects/?language=python)
219-
- [Partial update objects](https://algolia.com/doc/api-reference/api-methods/partial-update-objects/?language=python)
220-
- [Delete objects](https://algolia.com/doc/api-reference/api-methods/delete-objects/?language=python)
221-
- [Delete by query](https://algolia.com/doc/api-reference/api-methods/delete-by-query/?language=python)
222-
- [Get objects](https://algolia.com/doc/api-reference/api-methods/get-objects/?language=python)
223-
- [Custom batch](https://algolia.com/doc/api-reference/api-methods/batch/?language=python)
224-
- [Wait for operations](https://algolia.com/doc/api-reference/api-methods/wait-task/?language=python)
220+
- [Add objects](https://algolia.com/doc/api-reference/api-methods/add-objects/?language=python)
221+
- [Update objects](https://algolia.com/doc/api-reference/api-methods/update-objects/?language=python)
222+
- [Partial update objects](https://algolia.com/doc/api-reference/api-methods/partial-update-objects/?language=python)
223+
- [Delete objects](https://algolia.com/doc/api-reference/api-methods/delete-objects/?language=python)
224+
- [Delete by query](https://algolia.com/doc/api-reference/api-methods/delete-by-query/?language=python)
225+
- [Get objects](https://algolia.com/doc/api-reference/api-methods/get-objects/?language=python)
226+
- [Custom batch](https://algolia.com/doc/api-reference/api-methods/batch/?language=python)
227+
- [Wait for operations](https://algolia.com/doc/api-reference/api-methods/wait-task/?language=python)
228+
229+
225230

226231

227232

228233
### Settings
229234

230-
- [Get settings](https://algolia.com/doc/api-reference/api-methods/get-settings/?language=python)
231-
- [Set settings](https://algolia.com/doc/api-reference/api-methods/set-settings/?language=python)
235+
- [Get settings](https://algolia.com/doc/api-reference/api-methods/get-settings/?language=python)
236+
- [Set settings](https://algolia.com/doc/api-reference/api-methods/set-settings/?language=python)
237+
238+
232239

233240

234241

235242
### Manage indices
236243

237-
- [List indexes](https://algolia.com/doc/api-reference/api-methods/list-indices/?language=python)
238-
- [Delete index](https://algolia.com/doc/api-reference/api-methods/delete-index/?language=python)
239-
- [Copy index](https://algolia.com/doc/api-reference/api-methods/copy-index/?language=python)
240-
- [Move index](https://algolia.com/doc/api-reference/api-methods/move-index/?language=python)
241-
- [Clear index](https://algolia.com/doc/api-reference/api-methods/clear-index/?language=python)
244+
- [List indexes](https://algolia.com/doc/api-reference/api-methods/list-indices/?language=python)
245+
- [Delete index](https://algolia.com/doc/api-reference/api-methods/delete-index/?language=python)
246+
- [Copy index](https://algolia.com/doc/api-reference/api-methods/copy-index/?language=python)
247+
- [Move index](https://algolia.com/doc/api-reference/api-methods/move-index/?language=python)
248+
- [Clear index](https://algolia.com/doc/api-reference/api-methods/clear-index/?language=python)
249+
250+
242251

243252

244253

245254
### API Keys
246255

247-
- [Create secured API Key](https://algolia.com/doc/api-reference/api-methods/generate-secured-api-key/?language=python)
248-
- [Add API Key](https://algolia.com/doc/api-reference/api-methods/add-api-key/?language=python)
249-
- [Update API Key](https://algolia.com/doc/api-reference/api-methods/update-api-key/?language=python)
250-
- [Delete API Key](https://algolia.com/doc/api-reference/api-methods/delete-api-key/?language=python)
251-
- [Get API Key permissions](https://algolia.com/doc/api-reference/api-methods/get-api-key/?language=python)
252-
- [List API Keys](https://algolia.com/doc/api-reference/api-methods/list-api-keys/?language=python)
256+
- [Create secured API Key](https://algolia.com/doc/api-reference/api-methods/generate-secured-api-key/?language=python)
257+
- [Add API Key](https://algolia.com/doc/api-reference/api-methods/add-api-key/?language=python)
258+
- [Update API Key](https://algolia.com/doc/api-reference/api-methods/update-api-key/?language=python)
259+
- [Delete API Key](https://algolia.com/doc/api-reference/api-methods/delete-api-key/?language=python)
260+
- [Get API Key permissions](https://algolia.com/doc/api-reference/api-methods/get-api-key/?language=python)
261+
- [List API Keys](https://algolia.com/doc/api-reference/api-methods/list-api-keys/?language=python)
262+
263+
253264

254265

255266

256267
### Synonyms
257268

258-
- [Save synonym](https://algolia.com/doc/api-reference/api-methods/save-synonym/?language=python)
259-
- [Batch synonyms](https://algolia.com/doc/api-reference/api-methods/batch-synonyms/?language=python)
260-
- [Delete synonym](https://algolia.com/doc/api-reference/api-methods/delete-synonym/?language=python)
261-
- [Clear all synonyms](https://algolia.com/doc/api-reference/api-methods/clear-synonyms/?language=python)
262-
- [Get synonym](https://algolia.com/doc/api-reference/api-methods/get-synonym/?language=python)
263-
- [Search synonyms](https://algolia.com/doc/api-reference/api-methods/search-synonyms/?language=python)
269+
- [Save synonym](https://algolia.com/doc/api-reference/api-methods/save-synonym/?language=python)
270+
- [Batch synonyms](https://algolia.com/doc/api-reference/api-methods/batch-synonyms/?language=python)
271+
- [Delete synonym](https://algolia.com/doc/api-reference/api-methods/delete-synonym/?language=python)
272+
- [Clear all synonyms](https://algolia.com/doc/api-reference/api-methods/clear-synonyms/?language=python)
273+
- [Get synonym](https://algolia.com/doc/api-reference/api-methods/get-synonym/?language=python)
274+
- [Search synonyms](https://algolia.com/doc/api-reference/api-methods/search-synonyms/?language=python)
275+
- [Export Synonyms](https://algolia.com/doc/api-reference/api-methods/export-synonyms/?language=python)
276+
277+
264278

265279

266280

267281
### Query rules
268282

269-
- [Save a single rule](https://algolia.com/doc/api-reference/api-methods/rules-save/?language=python)
270-
- [Batch save multiple rules](https://algolia.com/doc/api-reference/api-methods/rules-save-batch/?language=python)
271-
- [Read a rule](https://algolia.com/doc/api-reference/api-methods/rules-read/?language=python)
272-
- [Delete a single rule](https://algolia.com/doc/api-reference/api-methods/rules-delete/?language=python)
273-
- [Clear all rules](https://algolia.com/doc/api-reference/api-methods/rules-clear/?language=python)
274-
- [Search for rules](https://algolia.com/doc/api-reference/api-methods/rules-search/?language=python)
283+
- [Save a single rule](https://algolia.com/doc/api-reference/api-methods/rules-save/?language=python)
284+
- [Batch save multiple rules](https://algolia.com/doc/api-reference/api-methods/rules-save-batch/?language=python)
285+
- [Read a rule](https://algolia.com/doc/api-reference/api-methods/rules-read/?language=python)
286+
- [Delete a single rule](https://algolia.com/doc/api-reference/api-methods/rules-delete/?language=python)
287+
- [Clear all rules](https://algolia.com/doc/api-reference/api-methods/rules-clear/?language=python)
288+
- [Search for rules](https://algolia.com/doc/api-reference/api-methods/rules-search/?language=python)
289+
- [Export rules](https://algolia.com/doc/api-reference/api-methods/rules-export/?language=python)
290+
291+
275292

276293

277294

278295
### MultiClusters
279296

280-
- [Assign or Move userID](https://algolia.com/doc/api-reference/api-methods/assign-user-id/?language=python)
281-
- [Get top userID](https://algolia.com/doc/api-reference/api-methods/get-top-user-id/?language=python)
282-
- [Get userID](https://algolia.com/doc/api-reference/api-methods/get-user-id/?language=python)
283-
- [List clusters](https://algolia.com/doc/api-reference/api-methods/list-clusters/?language=python)
284-
- [List userID](https://algolia.com/doc/api-reference/api-methods/list-user-id/?language=python)
285-
- [Remove userID](https://algolia.com/doc/api-reference/api-methods/remove-user-id/?language=python)
286-
- [Search userID](https://algolia.com/doc/api-reference/api-methods/search-user-id/?language=python)
297+
- [Assign or Move userID](https://algolia.com/doc/api-reference/api-methods/assign-user-id/?language=python)
298+
- [Get top userID](https://algolia.com/doc/api-reference/api-methods/get-top-user-id/?language=python)
299+
- [Get userID](https://algolia.com/doc/api-reference/api-methods/get-user-id/?language=python)
300+
- [List clusters](https://algolia.com/doc/api-reference/api-methods/list-clusters/?language=python)
301+
- [List userID](https://algolia.com/doc/api-reference/api-methods/list-user-id/?language=python)
302+
- [Remove userID](https://algolia.com/doc/api-reference/api-methods/remove-user-id/?language=python)
303+
- [Search userID](https://algolia.com/doc/api-reference/api-methods/search-user-id/?language=python)
304+
305+
287306

288307

289308

290309
### Advanced
291310

292-
- [Get latest logs](https://algolia.com/doc/api-reference/api-methods/get-logs/?language=python)
311+
- [Get latest logs](https://algolia.com/doc/api-reference/api-methods/get-logs/?language=python)
312+
293313

294314

295315

@@ -299,4 +319,3 @@ search.start();
299319
- **Need help**? Ask a question to the [Algolia Community](https://discourse.algolia.com/) or on [Stack Overflow](http://stackoverflow.com/questions/tagged/algolia).
300320
- **Found a bug?** You can open a [GitHub issue](https://github.com/algolia/algoliasearch-client-python/issues).
301321

302-

0 commit comments

Comments
 (0)