A Xapian backend for Haystack
Python Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
tests Fixed tests for Xapian 1.3. Nov 14, 2015
.coveragerc Added coveralls to travis build. Nov 12, 2015
.gitignore Updated .gitignore to ignore MANIFEST Dec 7, 2009
.travis.yml Added Python 3 to build. Nov 13, 2015
AUTHORS Updated narrow_queries in backend search to AND queries rather than O… May 28, 2012
LICENSE Switched license back to GPL v2. Jul 14, 2011
MANIFEST.in
README.rst
install_xapian.sh
requirements.txt Updated README and requirements with latest updates. Apr 16, 2015
setup.py Updated setup.py and README. Nov 16, 2015
xapian_backend.py Fixed #128 -- Added support to Python 3. Nov 14, 2015

README.rst

Xapian backend for Django-Haystack

https://travis-ci.org/notanumber/xapian-haystack.svg?branch=master https://coveralls.io/repos/notanumber/xapian-haystack/badge.svg?branch=master&service=github

Xapian-haystack is a backend of Django-Haystack for the Xapian search engine. Thanks for checking it out.

You can find more information about Xapian here.

Features

Xapian-Haystack provides all the standard features of Haystack:

  • Weighting
  • Faceted search (date, query, etc.)
  • Sorting
  • Spelling suggestions
  • EdgeNGram and Ngram (for autocomplete)

Requirements

  • Python 2.7 or 3.3
  • Django 1.6+
  • Django-Haystack 2
  • Xapian 1.2.19+

In particular, we build this backend on Travis using:

  • Python 2.7 and 3.3
  • Django 1.6, 1.7 and 1.8
  • Django-Haystack (master)
  • Xapian 1.2.19 (in Python 2) and 1.3.3 (in both)

Installation

First, install Xapian in your machine e.g. with the script provided, install_xapian.sh. Call it after activating the virtual environment to install:

source <path>/bin/activate
./install_xapian.sh <version>

<version> must be >=1.3.0 for Python 3 envs. This takes around 10 minutes.

Finally, install Xapian-Haystack by running:

pip install git+https://github.com/notanumber/xapian-haystack.git

Configuration

Xapian is configured as other backends of Haystack. You have to define the connection to the database, which is done to a path to a directory, e.g:

HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'xapian_backend.XapianEngine',
        'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index')
    },
}

The backend has the following optional settings:

  • HAYSTACK_XAPIAN_LANGUAGE: the stemming language; the default is english and the list of available languages can be found here.
  • HAYSTACK_XAPIAN_WEIGHTING_SCHEME: a tuple with parameters to be passed to the weighting scheme BM25. By default, it uses the same parameters as Xapian recommends; this setting allows you to change them.
  • HAYSTACK_XAPIAN_FLAGS: the options used to parse AutoQueries; the default is FLAG_PHRASE | FLAG_BOOLEAN | FLAG_LOVEHATE | FLAG_WILDCARD | FLAG_PURE_NOT See here for more information on what they mean.
  • HAYSTACK_XAPIAN_STEMMING_STRATEGY: This option lets you chose the stemming strategy used by Xapian. Possible values are STEM_NONE, STEM_SOME, STEM_ALL, STEM_ALL_Z, where STEM_SOME is the default. See here for more information about the different strategies.

Testing

Xapian-Haystack has a test suite in continuous deployment in Travis. The script .travis.yml contains the steps required to run the test suite.

Source

The source code can be found in github.

Credits

Xapian-Haystack is maintained by Jorge C. Leitão; David Sauve was the main contributor of Xapian-Haystack and Xapian-Haystack was originally funded by Trapeze. ANtlord implemented support for EdgeNgram and Ngram.

License

Xapian-haystack is free software licenced under GNU General Public Licence v2 and Copyright (c) 2009, 2010, 2011, 2012 David Sauve, 2009, 2010 Trapeze, 2014 Jorge C. Leitão. It may be redistributed under the terms specified in the LICENSE file.

Questions, Comments, Concerns:

Feel free to open an issue here or pull request your work.

You can ask questions on the django-haystack mailing list: or in the irc #haystack.