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.0.0b11.zip (305.2 kB view details)

Uploaded Source

Whoosh-1.0.0b11.tar.gz (254.0 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b11-py2.6.egg (405.9 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b11.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b11.zip
Algorithm Hash digest
SHA256 b08fa1dd075f2e01d85d47a61b41efa480e0a81852968c6868e999b382018070
MD5 88e21ef611af09e038a0f3da0fcf7b04
BLAKE2b-256 71f93db2d8603479ad2cb6243118b1c9db91e88afc06cea51e62a6e7f76483c4

See more details on using hashes here.

File details

Details for the file Whoosh-1.0.0b11.tar.gz.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b11.tar.gz
Algorithm Hash digest
SHA256 c431b54ff279f6d17c4937eb70dbb5e95135d98ebe7b4155c6bd5a2623932b01
MD5 9b0009a66a9acda4b48c51a9405a0caf
BLAKE2b-256 c888392eeee4ea0698f57475619198e9eb48c5d70eb954d4187ed8745617d2f3

See more details on using hashes here.

File details

Details for the file Whoosh-1.0.0b11-py2.6.egg.

File metadata

File hashes

Hashes for Whoosh-1.0.0b11-py2.6.egg
Algorithm Hash digest
SHA256 3e05117bcf66c69c92f3c7190658877c943d879e6e92109fab5142aa06d4aff1
MD5 64a7862824e2c6415dc04ed45e75b9b8
BLAKE2b-256 85d064a79dc11819e7a755a82833464ac3c712a4d8ebc0572e070ed2427455de

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