This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!
Project Description

WhooshDoc is an indexed, full-text search tool for Python docstrings. It uses Whoosh to do the indexing and searching, hence the name. It includes tools for collecting docstrings to index them and for searching the index.

Prerequisites

For searching a prepared index, all you need is Whoosh. WhooshDoc uses epydoc to traverse packages and collect their docstrings in order to build a search index. However, epydoc is not required; you can add to a WhooshDoc index using the Whoosh API (see whooshdoc/util.py for the schema), without using epydoc.

This package uses setuptools for installation and for locating a default WhooshDoc index. WhooshDoc uses argparse for command line arguments.

Installation

You can install WhooshDoc, along with its dependencies, using with setuptools’ easy_install:

$ easy_install WhooshDoc

or via the normal setup.py mechanism after downloading and unpacking the tarball:

$ cd WhooshDoc-1.0
$ python setup.py install

To use the wxPython search GUI, you must install Enthought’s Traits and TraitsBackendWX packages. To do this, use the following easy_install command:

$ easy_install 'WhooshDoc[ui]'

The development source may be checked out via Subversion:

$ svn co https://svn.enthought.com/svn/enthought/WhooshDoc/trunk WhooshDoc

wdoc

WhooshDoc comes with one script, wdoc. It has several sub-commands. Use “wdoc –help” and “wdoc <sub-command> –help” to see detailed help.

To index a package using epydoc to collect docstrings, use “wdoc index”. For example:

$ wdoc index numpy

To use the console search utility, use “wdoc search”. For example:

$ wdoc search --help   # For an explanation of the query syntax.
$ wdoc search bessel or airy not filter
$ wdoc search '"phrase searches need weird quoting"'
              # because shells also interpret quote characters.

To use the wxPython GUI, use “wdoc ui”. For example:

$ wdoc ui
$ wdoc ui bessel or airy not filter

To explicitly specify the WhooshDoc index directory, use the -i/–index option before any of these sub-commands. For example:

$ wdoc --index ~/Library/WhooshDoc search bessel

To remove certain docstrings (e.g., because you updated a package and want to reindex it), use “wdoc delgroups”. For example:

# First, index a couple of scipy packages with the group name "scipy"
$ wdoc index --group scipy scipy.linalg scipy.optimize
# Now delete them.
$ wdoc delgroups scipy

IPython

WhooshDoc includes an IPython “magic” command, %whoosh, which performs a WhooshDoc query and presents the results in the console, like the “wdoc search” command. The %whoosh command integrates with IPython’s help mechanisms to display the help for the individual items. To enable it, add the following to your ipy_user_conf.py file:

from whooshdoc.ipython import enable
enable('/path/to/whooshdoc/index')

Now, you can search using %whoosh in IPython. For example:

In [10]: %whoosh bessel or airy not filter

Bugs

Please make a ticket on the Enthought Tool Suite (ETS) Trac instance:

https://svn.enthought.com/enthought

Or send an email to the enthought-dev mailing list:

https://mail.enthought.com/mailman/listinfo/enthought-dev

To Do

  • Simple web app using wsgiref.
Release History

Release History

1.0

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

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
WhooshDoc-1.0-py2.5.egg (38.2 kB) Copy SHA256 Checksum SHA256 2.5 Egg May 21, 2009
WhooshDoc-1.0.tar.gz (17.6 kB) Copy SHA256 Checksum SHA256 Source May 21, 2009

Supported By

WebFaction WebFaction Technical Writing 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 Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting