comparison doc/installation.txt @ 5096:e74c3611b138

- issue2550636, issue2550909: Added support for Whoosh indexer. Also adds new config.ini setting called indexer to select indexer. See ``doc/upgrading.txt`` for details. Initial patch done by David Wolever. Patch modified (see ticket or below for changes), docs updated and committed. I have an outstanding issue with test/test_indexer.py. I have to comment out all imports and tests for indexers I don't have (i.e. mysql, postgres) otherwise no tests run. With that change made, dbm, sqlite (rdbms), xapian and whoosh indexes are all passing the indexer tests. Changes summary: 1) support native back ends dbm and rdbms. (original patch only fell through to dbm) 2) Developed whoosh stopfilter to not index stopwords or words outside the the maxlength and minlength limits defined in index_common.py. Required to pass the extremewords test_indexer test. Also I removed a call to .lower on the input text as the tokenizer I chose automatically does the lowercase. 3) Added support for max/min length to find. This was needed to pass extremewords test. 4) Added back a call to save_index in add_text. This allowed all but two tests to pass. 5) Fixed a call to: results = searcher.search(query.Term("identifier", identifier)) which had an extra parameter that is an error under current whoosh. 6) Set limit=None in search call for find() otherwise it only return 10 items. This allowed it to pass manyresults test Also due to changes in the roundup code removed the call in indexer_whoosh to from roundup.anypy.sets_ import set since we use the python builtin set.
author John Rouillard <rouilj@ieee.org>
date Sat, 25 Jun 2016 20:10:03 -0400
parents 1c992cb4301a
children 67fad01d2009
comparison
equal deleted inserted replaced
5095:d3ba0b254dbb 5096:e74c3611b138
65 installed and used. You will need to run the "roundup-admin reindex" 65 installed and used. You will need to run the "roundup-admin reindex"
66 command if the tracker has existing data. 66 command if the tracker has existing data.
67 67
68 Roundup requires Xapian 1.0.0 or newer. 68 Roundup requires Xapian 1.0.0 or newer.
69 69
70 Whoosh full-text indexer
71 The Whoosh_ full-text indexer is also supported and will be used by
72 default if it is available (and Xapian is not installed). This is
73 recommended if you are anticipating a large number of issues (> 5000).
74
75 You may install Whoosh at any time, even after a tracker has been
76 installed and used. You will need to run the "roundup-admin reindex"
77 command if the tracker has existing data.
78
79 Roundup was tested with Whoosh 2.5.7, but earlier versions in the
80 2.0 series may work. Whoosh is a pure python indexer so it is slower
81 than Xapian, but should be useful for moderately sized trackers.
82 It uses the StandardAnalyzer which is suited for Western languages.
83
70 pyopenssl 84 pyopenssl
71 If pyopenssl_ is installed the roundup-server can be configured 85 If pyopenssl_ is installed the roundup-server can be configured
72 to serve trackers over SSL. If you are going to serve roundup via 86 to serve trackers over SSL. If you are going to serve roundup via
73 proxy through a server with SSL support (e.g. apache) then this is 87 proxy through a server with SSL support (e.g. apache) then this is
74 unnecessary. 88 unnecessary.
86 100
87 Windows Service 101 Windows Service
88 You can run Roundup as a Windows service if pywin32_ is installed. 102 You can run Roundup as a Windows service if pywin32_ is installed.
89 103
90 .. _Xapian: http://xapian.org/ 104 .. _Xapian: http://xapian.org/
105 .. _Whoosh: https://bitbucket.org/mchaput/whoosh/wiki/Home
91 .. _pytz: http://www.python.org/pypi/pytz 106 .. _pytz: http://www.python.org/pypi/pytz
92 .. _Olson tz database: http://www.twinsun.com/tz/tz-link.htm 107 .. _Olson tz database: http://www.twinsun.com/tz/tz-link.htm
93 .. _pyopenssl: http://pyopenssl.sourceforge.net 108 .. _pyopenssl: http://pyopenssl.sourceforge.net
94 .. _pyme: http://pyme.sourceforge.net 109 .. _pyme: http://pyme.sourceforge.net
95 .. _pywin32: http://pypi.python.org/pypi/pywin32 110 .. _pywin32: http://pypi.python.org/pypi/pywin32

Roundup Issue Tracker: http://roundup-tracker.org/