Dipus is a simple full-text search server using Whoosh for Sphinx
Project description
Dipus is a simple full-text search server using Whoosh. Dipus is integrated to the Sphinx document builder .
You can search document quickly and with N-gram.
How to install
% pip install dipus
Dependencies
Python 2.7
Sphinx
whoosh
simplejson
bottle
How to Use
Start dipus server
python -m dipus.websetup -c conf.json
conf.json example
{ "host": "192.168.1.20" "port": 9876, "indexroot": "/path/to/index" }
Register sphinx document
Add extension to your conf.py
extensions = ['dipus.dipusbuilder'] dipus_host_url = "http://192.168.1.20:9876" dipus_index = "test_rst"
Run builder
% sphinx-build -b dipus source build
CAUTION: builder will overwrite _static/search_dipus.js and _template/search_dipus.html.
copy search file
Note: This required once when after you change conf.py dipus related values.
% cp _template/search_dipus.html _template_search.html
If you have created your own search.html, please merge it.
make html as usual:
% make html
Note about builder will be done quickly, as “fire-and-forget”. But indexing itself on the server is not so quick. Please be patient until all your document will be indexed.
Search from sphinx document
Just open your search box and type.
Requirements
Python 2.7 (sorry, not 3 currently)
sphinx
whoosh
simplejson
bottle
Security
Dipus is for the internal use only.
If you want to use at the public, use google.
TODO
test test test
Security
Python 3
Admin Screen
correct highlighting(a.k.a. snippet) on the search result
logging
search over multiple documents
Analyzer selected by each document
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.