Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

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


  • Python 2.7
  • Sphinx
  • whoosh
  • simplejson
  • bottle

How to Use

Start dipus server

python -m dipus.websetup -c conf.json

conf.json example

  "indexroot": "/path/to/index"

Dipus server default url is “”.

Register sphinx document

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

and there are optional settings.

#dipus_server_url = ""
#  url of dipus server
#  Default is "http://localhost:9876"

#dipus_index = "test_rst"
#  identifier of this document
#  Default is same as 'project' in
  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 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.

  1. (optional) add dipus builder to Makefile

    Add line which invoke dipus builder in the html section in Makefile as blow.

        $(SPHINXBUILD) -b dipus $(ALLSPHINXOPTS) $(BUILDDIR)/html
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
    Then, whenever type 'make html', documents are registerd.

Search from sphinx document

Just open your search box and type.


  • Python 2.7 (sorry, not 3 currently)
  • sphinx
  • whoosh
  • simplejson
  • bottle


Dipus is for the internal use only.

If you want to use at the public, use google.


  • 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

Release History

This version
History Node


History Node


History Node


History Node


History Node


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
(157.9 kB) Copy SHA256 Hash SHA256
Source None Sep 5, 2012

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers