v0.22.0 🐍

This version makes this package compatible with Meilisearch v0.29.0 🎉
Check out the changelog of Meilisearch v0.29.0 for more information on the changes.

🚀 Enhancements

• Ensure support to the new search query parameter matchingStrategy (#522) @brunoocasali
• Ensure support to keys with wildcarded actions.
  • actions field during key creation now accepts wildcards on actions. For example, indexes.* provides rights to indexes.create, indexes.get,indexes.delete, indexes.delete, and indexes.update. (#521) @brunoocasali

⚠️ Breaking Changes

This breaking change may not affect you, but in any case, you should check your search queries if you want to keep the same behavior from v0.28.

• The NOT filter keyword does not have an implicitly EXIST operator anymore. Check out for more information: meilisearch/meilisearch#2486

Thanks again to @alallema, @brunoocasali, ! 🎉

v0.21.0 🐍

⚠️ Breaking changes

• Drop python 3.6 support (#529) @sanders41

🐛 Bug Fixes

• Fix required package (#535) @alallema

Thanks again to @alallema and @sanders41! 🎉

v0.20.0 🐍 [DEPRECATED]

Note: ⚠️ ⚠️ ⚠️
This release replaces the 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! 🎉

v0.19.2 🐍 [DEPRECATED]

⚠️ ⚠️
You should be aware that this release contains a breaking-change. And you probably face problems like this: #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! 🎉

v0.19.1 🐍

🚀 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! 🎉

v0.19.0 🐍

This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of Meilisearch 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! 🎉

v0.18.3 🐍

This version makes this package compatible with Meilisearch v0.27.0🎉
Check out the changelog of Meilisearch 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

v0.18.2 🐍

🚀 Enhancements

• Add User-Agent header to have analytics in every HTTP request (#433) @brunoocasali

Analytics is enabled by default in the server, but you can disable them by following this guide
Also, of course, every analytics data we collect are ANONYMOUS read the guide for more information.

Thanks again to @alallema, @brunoocasali! 🎉

v0.18.1 🐍

This version makes this package compatible with MeiliSearch v0.25 up to v0.26.0.
🎉 Check out the changelog of MeiliSearch v0.26.0 for more information about the :danger: Breaking changes about the flag and dump new behavior. (#407)

🚀 Enhancements

• Add package version (#409) @brunoocasali
• Added new method generateTenantToken() as a result of the addition of the multi-tenant functionality.
  This method creates a JWT tenant token that will allow the user to have multi-tenant indexes and thus restrict access to documents based on the end-user making the search request. (#412) @alallema

Thanks again to @alallema, @brunoocasali, @curquiza! 🎉

v0.18.0 🐍

This package version is compatible with MeiliSearch v0.25.0 (#370)

⚠️ Breaking changes

• This package is only compatible with MeiliSearch v0.25.0 and later, but not with v0.24.0 and older. Be sure you are using at least MeiliSearch v0.25.0 or newer before doing the upgrade.
  Why isn't it compatible?
  • MeiliSearch v0.25.0 uses Authorization header instead of X-Meili-API-Key (#371)
  • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points
• Remove delete_index_if_exists and get_or_create_index (#381) @alallema
• Redesign update API to task API (#372) @alallema
  • All the actions on indexes are now asynchronous check out the task API references and the asynchronous tasks guide
    • create_index(), update_index(), delete_index() are now asynchrone and return a task response instead of an Index.
    • index.create and index.delete from index return a task.
    • wait_for_pending_update() is renamed into wait_for_task and is accessible from index and from client.
    • the current index.wait_for_task() method call /tasks/:uid
    • index.get_update_status is renamed index.get_task
    • index.get_all_update_status is renamed index.get_tasks
    • new method client.wait_for_task() call /tasks/:uid
    • new method client.get_tasks that calls /tasks
    • new method client.get_task that calls /tasks/:uid
      Notes: The only two methods that now return an Index are client.index() and client.get_index()
• Change apiKey to api_key to comply with pylint (#386) @alallema
• Change client.get_keys does not return an object of keys, but an array of keys. Check out keys API references.
• Changes related to the next MeiliSearch release (v0.25.0) (#370)

🚀 Enhancements

• Remove tests from wheel (#368) @sanders41
• Add type attribute to error handler (#388) @voloyev
• Addition related to API keys (#382) @alallema
  • Granular management of API keys is now added to MeiliSearch. New methods have been created to manage this:
    • client.get_key get information about a specific API key.
    • client.create_key create a new API key.
    • client.delete_key delete an API key.
    • client.update_key update an API key.
  • Check out the documentation guide.

🐛 Bug Fixes

• Add redundant export to fix import error (#384) @sanders41
• Fix MeiliSearchApiError and MeiliSearchError double period in message (#390) @sanders41

Thanks again to @alallema, @sanders41, and @voloyev! 🎉