This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
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

{
  "indexroot": "/path/to/index"
}

Dipus server default url is “http://0.0.0.0:9876”.

Register sphinx document

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

and there are optional settings.

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

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

  1. (optional) add dipus builder to Makefile

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

      html:
        $(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.

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
Release History

Release History

0.0.5

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.4

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
dipus-0.0.5.tar.gz (157.9 kB) Copy SHA256 Checksum SHA256 Source Sep 5, 2012

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting