Haystack for Django REST Framework

Contents:

About

Small library aiming to simplify using Haystack with Django REST Framework

Features

Supported Python and Django versions:

Python >=3.11, <3.15

All supported versions of Django

Installation

It’s in the cheese shop!

$ pip install drf-haystack

Requirements

A Supported Django install

Django REST Framework v3.16 and later

Haystack v3.3.0 and later, below v4

A supported search engine such as Solr, Elasticsearch, Whoosh, etc.

Python bindings for the chosen backend (see below).

(geopy and libgeos if you want to use geo spatial filtering)

Python bindings

You will also need to install python bindings for the search engine you’ll use.

Elasticsearch

See haystack Elasticsearch docs for details

$ pip install elasticsearch>=7.0.0,<8.0.0   # For Elasticsearch 7.x

Solr

See haystack Solr docs for details.

$ pip install pysolr

Whoosh

See haystack Whoosh docs for details.

$ pip install whoosh

Xapian

See haystack Xapian docs for details.

Contributors

This library has mainly been written by me while working at Inonit. I have also had some help from these amazing people! Thanks guys!

See the full list of contributors.