-Whoosh is a fast, pure-Python indexing and search library. Programmers
-can use it to easily add search functionality to their applications and
-websites. Because Whoosh is pure Python, you don't have to compile or
-install a binary support library and/or make Python work with a JVM, yet
-Whoosh is still very fast at indexing and searching. Every part of how
-Whoosh works can be extended or replaced to meet your needs exactly.
+Whoosh is a fast, featureful full-text indexing and searching library
+implemented in pure Python. Programmers can use it to easily add search
+functionality to their applications and websites. Every part of how Whoosh
+works can be extended or replaced to meet your needs exactly.
+Some of Whoosh's features include:
+* Pure-Python. No compilation or binary packages needed, no mysterious crashes.
+* Fielded indexing and search.
+* Fast indexing and retrieval -- faster than any other pure-Python, scoring,
+ full-text search solution I know of.
+* Pluggable scoring algorithm (including BM25F), text analysis, storage,
+* Powerful query language parsed by pyparsing.
+* Pure Python spell-checker (as far as I know, the only one).
+Whoosh might be useful in the following circumstances:
+* Anywhere a pure-Python solution is desirable to avoid having to build/compile
+ native libraries (or force users to build/compile them).
+* As a research platform (at least for programmers that find Python easier to
+ read and work with than Java ;)
+* When an easy-to-use Pythonic interface is more important to you than raw
+Whoosh was created and is maintained by Matt Chaput. It was originally created
+for use in the online help system of Side Effects Software's 3D animation
+software Houdini. Side Effects Software Inc. graciously agreed to open-source
This software is licensed under the terms of the Apache License version 2.
See LICENSE.txt for information.
-You can read the online documentation at
-The primary source of information is the main Whoosh web site:
+If you have ``setuptools`` or ``pip`` installed, you can use ``easy_install``
+or ``pip`` to download and install Whoosh automatically::
+* Read the online documentation at http://packages.python.org/Whoosh/
+* Join the Whoosh mailing list at http://groups.google.com/group/whoosh
+* File bug reports and view the Whoosh wiki at
+Download source releases from PyPI at http://pypi.python.org/pypi/Whoosh/
+You can check out the latest version of the source code using Mercurial::
+ hg clone http://bitbucket.org/mchaput/whoosh