Skip to main content

A MeiliSearch backend for Wagatil

Project description

Wagtail MeiliSearch

This is a (beta) Wagtail search backend for the https://github.com/meilisearch/MeiliSearch search engine.

Installation

poetry add wagtail_meilisearch or pip install wagtail_meilisearch

Configuration

See the [https://docs.meilisearch.com/guides/advanced_guides/installation.html#environment-variables-and-flags](MeiliSearch docs) for info on the values you want to add here.

WAGTAILSEARCH_BACKENDS = {
    'default': {
        'BACKEND': 'wagtail_meilisearch.backend',
        'HOST': os.environ.get('MEILISEARCH_HOST', 'http://127.0.0.1'),
        'PORT': os.environ.get('MEILISEARCH_PORT', '7700'),
        'MASTER_KEY': os.environ.get('MEILI_MASTER_KEY', '')
    },
}

Contributing

If you want to help with the development I'd be more than happy. The vast majority of the heavy lifting is done by MeiliSearch itself, but there is a TODO list...

TODO

  • Faceting
  • Implement boosting in the sort algorithm
  • Search results
  • Add support for the autocomplete api
  • Ensure we're getting results by relevance
  • Write tests
  • Performance improvements - particularly in the autocomplete query compiler which for some reason seems slower than the regular one.

Thanks

Thank you to the devs of https://github.com/wagtail/wagtail-whoosh. Reading the code over there was the only way I could work out how Wagtail Search backends are supposed to work.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail-meilisearch-0.1.1.tar.gz (6.5 kB view hashes)

Uploaded Source

Built Distribution

wagtail_meilisearch-0.1.1-py3-none-any.whl (7.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page