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 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

This version

2.3.0

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

Uploaded Source

Whoosh-2.3.0.tar.gz (881.6 kB view details)

Uploaded Source

File details

Details for the file Whoosh-2.3.0.zip.

File metadata

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

File hashes

Hashes for Whoosh-2.3.0.zip
Algorithm Hash digest
SHA256 19b4210e81e10d7f2da73e015682706a3a2bc34c1176a01b0588ce6e20e040f0
MD5 e35dc3151380d8a22ea0ddc9cd32552f
BLAKE2b-256 11ddb8232615b70d6352e068ffdbcb976831d57c37acec9034a21fd6b63d1fa7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-2.3.0.tar.gz
Algorithm Hash digest
SHA256 18bb918ab2b52fad4a4f3b8c6ec7780d2106a4f5658a7f3887f5be4b4dafc4ba
MD5 c3bc09021c2dd2e005f52862bc2f4d80
BLAKE2b-256 0bba621a3647c5e083870fa9387d031dac81073878c6c57c3a1f4fab090dc2c8

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