Skip to main content

Fast, pure-Python full text indexing, search, and spell checking library.

Project description

About Whoosh

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:

  • Pythonic API.

  • 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, posting format, etc.

  • Powerful query language.

  • 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 speed.

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 the code.

This software is licensed under the terms of the simplified BSD (A.K.A. “two clause” or “FreeBSD”) license. See LICENSE.txt for information.

Installing Whoosh

If you have setuptools or pip installed, you can use easy_install or pip to download and install Whoosh automatically:

$ easy_install Whoosh

or

$ pip install Whoosh

Learning more

Getting the source

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

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distributions

Whoosh-2.3.2.zip (985.6 kB view details)

Uploaded Source

Whoosh-2.3.2.tar.gz (882.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-2.3.2.zip.

File metadata

  • Download URL: Whoosh-2.3.2.zip
  • Upload date:
  • Size: 985.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-2.3.2.zip
Algorithm Hash digest
SHA256 7bd00804731730bdc6b5065635472935da5a99b37f965fe92eb20775e7365cff
MD5 b375cfd3310789b491818e4d2e193a88
BLAKE2b-256 4b554e7fd638852716772469ba1b416ed3efdc9a4c7e0a0ba13ef1ac145571b4

See more details on using hashes here.

File details

Details for the file Whoosh-2.3.2.tar.gz.

File metadata

  • Download URL: Whoosh-2.3.2.tar.gz
  • Upload date:
  • Size: 882.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-2.3.2.tar.gz
Algorithm Hash digest
SHA256 15d451a6045bffed6dfc141a72647ec350e08d218ac0f550b0120af81e5152c7
MD5 b35a67db364d1e0d8d32a10220a1db70
BLAKE2b-256 cf80264086f2be7ad5af23fb3a027e1d5351a7ab48f08dbd7c6be156a9b54c67

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page