Skip to main content

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

  1. Add extension to your conf.py
extensions = ['dipus.dipusbuilder']

dipus_host_url = "http://192.168.1.20:9876"
dipus_index = "test_rst"
  1. Run builder

    % sphinx-build -b dipus source build
    

    CAUTION: builder will overwrite _static/search_dipus.js and _template/search_dipus.html.

  2. 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.

  3. 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


Release history Release notifications

History Node

0.0.5

History Node

0.0.4

History Node

0.0.3

This version
History Node

0.0.2

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
dipus-0.0.2-py2.7.egg (19.7 kB) Copy SHA256 hash SHA256 Egg 2.7 Aug 21, 2012
dipus-0.0.2.tar.gz (287.1 kB) Copy SHA256 hash SHA256 Source None Aug 21, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page