Hopiu/xapian-haystack
1
0
Fork 0
mirror of https://github.com/Hopiu/xapian-haystack.git synced 2026-03-16 22:20:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Cleaned up README and added credits and license sections

Browse source
This commit is contained in:
David Sauve 2009-12-09 16:28:49 -05:00
parent 4f0f219ede
commit 67879dd1cd
1 changed files with 41 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README
View file

@ -1,11 +1,9 @@
Overview
--------
xapian-haystack is a backend for use with the Django Haystack search API.
xapian-haystack is a backend for use with the Django Haystack search API and the Xapian search engine.
More information on Haystack can be found here: http://haystacksearch.org/
xapian-haystack is licensed under the GPL, please see the included LICENSE
file for more information.
* More information on Haystack can be found here: http://haystacksearch.org/
* More information on Xapian can be found here: http://xapian.org
Requirements
------------
@ -19,7 +17,7 @@ Requirements
Notes
-----
- Due to an issue with mod_python possibly causing deadlocks with Xapian (http://trac.xapian.org/ticket/364), when the Python is not invoked through the "main interpreter", mod_python is not supported with xapian-haystack. It may work, with some tweaking, but your mileage will vary.
- Due to an issue with mod_python possibly causing deadlocks with Xapian (http://trac.xapian.org/ticket/364), when Python is not invoked through the "main interpreter", mod_python is not supported with xapian-haystack. It may work, with some tweaking, but your mileage will vary.
- Because Xapian does not support simultaneous WritableDatabase connections, it is *strongly* recommended that users take care when using RealTimeSearchIndex to either set `WSGIDaemonProcess processes=1` or use some other way of ensuring that there are not multiple attempts to write to the indexes. Alternatively, use SearchIndex and a cronjob to reindex content at set time intervals (sample cronjob can be found here: http://gist.github.com/216247) or derive your own SearchIndex to implement some other form of keeping your indexes up to date.
Installation
@ -28,34 +26,61 @@ Installation
1. Copy or symlink `xapian_backend.py` into `haystack/backends/` or install
it by running one of the following commands::
python setup.py install
python setup.py install
# or
or
pip install xapian-haystack
pip install xapian-haystack
# or
or
easy_install xapian-haystack
easy_install xapian-haystack
2. Add `HAYSTACK_XAPIAN_PATH` to `settings.py`
3. Set `HAYSTACK_SEARCH_ENGINE` to `xapian`
Testing
-------
The easiest way to test xapian-haystack is to symlink or copy the xapian_haystack/tests folder into the haystack/tests folder so that your source tree resembles this layout:
django-haystack
+---haystack
| |
| +---backends
| |
| +---solr_backend.py
| +---whoosh_backend.py
| +---xapian_backend.py
+---tests
|
+---core
+---solr_tests
+---whoosh_tests
+---xapian_tests
Once this is done, the tests can be executed in a similar fashion as the rest of the Haystack test-suite:
django-admin.py test xapian_tests --settings=xapian_settings
Source
------
The latest source code can always be found here: http://github.com/notanumber/xapian-haystack/
Testing
Credits
-------
Provided that Django, Haystack, and xapian-haystack are all in your Python
path, simply change to the xapian-haystack folder and execute:
xapian-haystack is maintained by [David Sauve](mailto:dsauve@trapeze.com), and is funded by [Trapeze](http://www.trapeze.com).
django-admin.py test tests --settings=tests.settings
License
-------
xapian-haystack is Copyright © 2009 David Sauve, Trapeze. It is free software, and 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
Feel free to open an issue here: http://github.com/notanumber/xapian-haystack/issues
Alternatively, ask questions on the django-haystack [mailing list](http://groups.google.com/group/django-haystack/) or [irc channel](irc://irc.freenode.net/haystack).