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 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 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 Apache License version 2. 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-1.7.1.zip (598.6 kB view details)

Uploaded Source

Whoosh-1.7.1.tar.gz (537.9 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.7.1.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.7.1.zip
Algorithm Hash digest
SHA256 696340d535e3f1d8007cd10596e0162b5c5a3ea6c0041552a7dfca0f848f7558
MD5 49eaa66274d4b42106984914bcbed9dd
BLAKE2b-256 b3afa290996244452a27db099cef9a6f1dc89cccc654dda5649a8677d549d86b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.7.1.tar.gz
Algorithm Hash digest
SHA256 04de401183b52b6f2c23968cbe2e20b1efeca072eef100850cbc78e3b73c0b31
MD5 b70a07ac1c7eebc1156e28f1bbcfa6c1
BLAKE2b-256 97d862fd3bcd47d532690cabe58fbed5374f7e60078c6685c5d65b9b6bf65c46

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