/usr/lib/python2.7/dist-packages/xapian_haystack-2.1.0.egg-info is in python-xapian-haystack 2.1.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | Metadata-Version: 1.1
Name: xapian-haystack
Version: 2.1.0
Summary: A Xapian backend for Haystack
Home-page: http://github.com/notanumber/xapian-haystack
Author: Jorge C. Leitão
Author-email: jorgecarleitao@gmail.com
License: GPL2
Download-URL: http://github.com/notanumber/xapian-haystack/tarball/2.1.0
Description: Xapian backend for Django-Haystack
==================================
.. _Travis: https://travis-ci.org/notanumber/xapian-haystack
.. image:: https://travis-ci.org/notanumber/xapian-haystack.svg?branch=master
:target: https://travis-ci.org/notanumber/xapian-haystack
.. image:: https://coveralls.io/repos/notanumber/xapian-haystack/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/notanumber/xapian-haystack?branch=master
Xapian-haystack is a backend of `Django-Haystack <http://haystacksearch.org/>`__
for the `Xapian <http://xapian.org>`__ search engine.
Thanks for checking it out.
You can find more information about Xapian `here <http://getting-started-with-xapian.readthedocs.org>`__.
Features
--------
Xapian-Haystack provides all the standard features of Haystack:
- Weighting
- Faceted search (date, query, etc.)
- Sorting
- Spelling suggestions
- EdgeNGram and Ngram (for autocomplete)
Limitations
-----------
The `endswith` search operation is not supported by Xapian-Haystack.
Requirements
------------
- Python 2.7 or 3+
- Django 1.8+
- Django-Haystack 2.5.1
- Xapian 1.2.19+
In particular, we build-test this backend in `Travis`_ using:
- Python 2.7 and 3.4
- Django 1.8, 1.9 and 1.10
- Django-Haystack (master)
- Xapian 1.2.19 (Python 2 only), 1.3.3 (both), and 1.4.1 (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 <http://xapian.org/docs/apidoc/html/classXapian_1_1Stem.html>`__.
- ``HAYSTACK_XAPIAN_WEIGHTING_SCHEME``: a tuple with parameters to be passed to the weighting scheme
`BM25 <https://en.wikipedia.org/wiki/Okapi_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 <http://xapian.org/docs/apidoc/html/classXapian_1_1QueryParser.html>`__ 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 <http://xapian.org/docs/apidoc/html/classXapian_1_1QueryParser.html#ac7dc3b55b6083bd3ff98fc8b2726c8fd>`__ 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 <http://github.com/notanumber/xapian-haystack/>`_.
Credits
-------
Xapian-Haystack is maintained by `Jorge C. Leitão <http://jorgecarleitao.net>`__;
`David Sauve <mailto:david.sauve@bag-of-holding.com>`__ was the main contributor of Xapian-Haystack and
Xapian-Haystack was originally funded by `Trapeze <http://www.trapeze.com>`__.
`Claudep <http://www.2xlibre.net>`__ is a frequent contributor.
`ANtlord <https://github.com/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 <http://github.com/notanumber/xapian-haystack/issues>`__
or pull request your work.
You can ask questions on the django-haystack `mailing list <http://groups.google.com/group/django-haystack/>`_:
or in the irc ``#haystack``.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Framework :: Django
|