Meilisearch

⚠️ Breaking changes

* Drop python 3.6 support (529) sanders41

🐛 Bug Fixes

* Fix required package (535) alallema

Thanks again to alallema and sanders41! 🎉

**Note:** ⚠️ ⚠️ ⚠️
This release replaces the [v0.19.2](https://github.com/meilisearch/meilisearch-python/releases/tag/v0.19.2), which should be a **minor** update instead of a **patch** update due to a Breaking Change

💥 Breaking changes
* API resource output as a class to utilize dot notation for attributes (513) ElamC
* `Document`, `Index`, and `Task` are now classes, and the attributes of these classes are now accessible via dot notation:
* `document.offset`, `document.limit`, `document.total`
* `task.uid`, `task.duration`, `task.status` ...

🚀 Enhancements
* Add pipenv install in the CONTRIBUTING guide (519) brunoocasali

Security
* Bump mako from 1.2.1 to 1.2.2 due to security issue (528)

🐛 Bug Fixes
* Add camel_converter to package dependencies (534) alallema

Thanks again to ElamC, alallema, brunoocasali! 🎉

⚠️ ⚠️
You should be aware that this release contains a `breaking-change`. And you probably face problems like this: https://github.com/meilisearch/meilisearch-python/issues/532

➡️ So we highly recommend you to move to `0.20.0` or go back to `0.19.1`.

🚀 Enhancements

* API resource output as class to utilize dot notation for attributes (513) ElamC
* Add pipenv install in the CONTRIBUTING guide (519) brunoocasali
* Bump mako from 1.2.1 to 1.2.2 due to security issue (528)

Thanks again to ElamC, alallema, brunoocasali! 🎉

🚀 Enhancements

* Add support to the pagination setting customization (504) voloyev
* Add faceting settings customization (506) voloyev

🐛 Bug Fixes

* Fix typing of Index.get_documents (501) sapristi

Thanks again to alallema, sapristi and voloyev! 🎉

This version makes this package compatible with Meilisearch v0.28.0 :tada:
Check out the changelog of [Meilisearch v0.28.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0) for more information on the changes.

💥 Breaking changes

- `update_key()` can update **only** `name` and `description` fields. 477
- `get_tasks()` has additional parameters for filtering:: `type`, `status` and `indexUid`. 476
- `client.get_tasks(...)` and `index.get_tasks()` now returns the following fields: `results`, `limit`, `from`, `next`.476
- `index.search` changes in the response `fields`: 478
- `nbHits` replaced with `estimatedTotalHits`
- `exhaustiveNbHits` is deleted
- `exhaustiveFacetsCount` is deleted
- `matches` renamed `showMatchesPosition`
- `facetsDistribution` response parameter is renamed `facetDistribution`.
- `index.search` changes in the request parameters: 478
- `matches` renamed `showMatchesPosition`
- `facetsDistribution` request parameter is renamed `facets`.
- `index.get_documents()` request parameters: 481
- `attributesToRetrieve` replaced with `fields`.
- `client.get_indexes` and `client.get_raw_indexes` now return the following fields: `results`, `limit`, `offset`, `total`. 478
- `index.get_documents` and `client.get_documents` now return the following fields: `results`, `limit`, `offset`, `total`. 481
- `index.get_documents` query parameter `attributesToRetrieve` is now called `fields` 481
- `client.get_dump_status` and `wait_for_dump_creation` have been removed 479
- `client.create_dump()` now returns tasks, similar to what add_documents or create_index returns 479
- `client.generate_tenant_token(api_key_uid, search_rules, expires_at)` has now a mandatory `api_key_uid` parameter which should contain the uid of a specific API key. 484

🚀 Enhancements

- `index.get_tasks` and `client.get_tasks` accept pagination metadata, added `limit` (default: 20), `from`. 476
- `client.get_indexes` accept pagination metadata, added `limit` (default: 20) and `offset` (default: 0). 478
- `client.get_keys` accept pagination metadata, added `limit` (default: 20) and `offset` (default: 0). 477
- `client.get_key(key_or_uid)` can now also find keys based on their key uid. 477
- `client.create_key(options)` lets you specify a custom uid (optionally) to create a new Key. 477
- `index.get_documents` now accepts pagination parameters: `limit` (default: 20) and `offset` (default: 0). 481
- Improve Docker configuration in the package (467)

Thanks again to alallema, curquiza, and roshammar! 🎉

This version makes this package compatible with Meilisearch v0.27.0🎉
Check out the changelog of [Meilisearch v0.27.0](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.27.0) for more information about the changes.

🚀 Enhancements

- Add new methods for the new typo tolerance settings 443 alallema
`index.get_typo_tolerance()`
`index.update_typo_tolerance(params)`
`index.reset_typo_tolerance()`
- Ensure nested field support 444 alallema
- Add new search parameters highlightPreTag, highlightPostTag and cropMarker 445 alallema