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

v0.17.0 🐍

This package version is compatible with MeiliSearch v0.24.0 (#353)

⚠️ Breaking changes

• Modification of the update method which now takes a primary as argument (#346) @sanders41
• Rename error_code and error_link into code and link in the error handler (#355) @curquiza

Thanks again to @Sukriti-sood, @Yoda-Canada, @alallema, @curquiza, @jrinder42, and @sanders41! 🎉

v0.16.2 🐍

This package version is compatible with MeiliSearch v0.23.0

Changes

• New format handling CSV NDJSON (#329) @alallema:
  • Add new index method add_documents_json(string_docs, primary_key)
  • Add new index method add_documents_ndjson(string_docs, primary_key)
  • Add new index method add_documents_csv(string_docs, primary_key)
  • Add new index method add_documents_raw(string_docs, primary_key, type)

Thanks again to @AbihaFatima, @alallema, @curquiza, @darensin01, @mk1107, and @moazfarrukh! 🎉

v0.16.1 🐍

This package version is compatible with MeiliSearch v0.22.0 🎉

Changes

• Add sort feature compatibility (#318) @alallema. More about sorting.
  • Add sortable attributes methods: get_sortable_attributes, set_sortable_attributes, reset_sortable_attributes.
  • Add sort parameter during search.

Thanks again to @alallema, @curquiza! 🎉

v0.16.0 🐍

This version makes this package compatible with MeiliSearch v0.21.0
🎉 Check out the changelog of MeiliSearch v0.21.0

Changes

• Update WaitForPendingUpdate status (#288) @alallema

Breaking changes ⚠️

• Rename attributes_for_faceting into filterable_attributes (#287) @alallema
• Changes related to the next MeiliSearch release (v0.21.0) (#250)

Bug

• Fixing str issues with MeiliSearchApiError (#306) @sanders41

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

v0.15.1 🐍

Changes

• Adding type hints and mypy (#267) @sanders41
• Adding delete if exists methods (#268) @sanders41

Thanks again to @sanders41! 🎉

v0.15.0 🐍

Changes

• Adding possibility to send body null and tests (#256) @alallema
• Adding method to add documents in batches (#260) @sanders41

Breaking changes ⚠️

• get_indexes returns a list of Index instance + add raw index methods (#261) @sanders41

Thanks again to @alallema, @bidoubiwa, @curquiza, and @sanders41! 🎉

v0.14.2 🐍

Changes

• Standardize health method (#246) @alallema

Thanks again to @alallema and @curquiza! 🎉

v0.14.1 🐍

Changes

• Added an option to specify a timeout duration (#232) @sanders41

Thanks again to @sanders41 @bb, and @ritwickdsouza! 🎉

v0.14.0 🐍

Changes

• Introduction of the index() method that replaces get_index(). get_index() is still available but does HTTP call, so this should be only used to fetch information from the MeiliSearch instance. See our Getting Started to use this package the right way (#175) @curquiza
• Add a new attribute in the Index class: primary_key. You can now use client.get_index('books').primary_key to access the primary key of your index. (#175) @curquiza
• Update dependencies

Breaking changes ⚠️

• get_index() is still present but does an HTTP call. This method should be only used to fetch information from the MeiliSearch instance, not to manipulate an Index object in your code base. Use index() instead. See our Getting Started to be sure using this SDK the most optimized way. (#175) @curquiza
• Rename info() into fetch_info() (#175) @curquiza
• Make the update_index() method return an Index instance (#176) @curquiza

Thanks again to @bidoubiwa, @curquiza, and most of all to @kamyar for having refactored the tests suite! 🎉