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.0b21.zip (325.9 kB view details)

Uploaded Source

Whoosh-1.0.0b21.tar.gz (275.3 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b21-py2.6.egg (438.1 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b21.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b21.zip
Algorithm Hash digest
SHA256 2e7cbb9efc19aad5ddcae9e612139bdcda5a75afe873e25dca3d09cec816c0b6
MD5 b14ad2ec6e6c1b5311c404021f89f1a2
BLAKE2b-256 f4e7bc12b218d6258f6f8f6fd4778633eff97b2a738cd0b1ad65e87540bc86ac

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b21.tar.gz
Algorithm Hash digest
SHA256 34bb1f2aafd0d21fc7fd5daf1f3088bf99d3b78d79810e5554f066ff8d23bc58
MD5 71458013474dc8c695462ddea8b181b2
BLAKE2b-256 bfef2a5b8b8a4c894f652b241c5589e6b96198bafd2f793f19d4a72b1fc8d543

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Whoosh-1.0.0b21-py2.6.egg
Algorithm Hash digest
SHA256 268fb094b25d51334432a1ca3af1d2fb31a8729087157e0170a790785233ab6b
MD5 e56201d0ff019e0b38f6a043fe19e492
BLAKE2b-256 c61f8e65d25e65990d8f99494ae75d3acf6d7d4806a78186275975bcb5a56b2d

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