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

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

Uploaded Source

Whoosh-2.0.0.tar.gz (481.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-2.0.0.zip.

File metadata

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

File hashes

Hashes for Whoosh-2.0.0.zip
Algorithm Hash digest
SHA256 e17afe4d370bd928d5b7582f1b34eff78bc8a249b76878b41a13536297cc8c11
MD5 e58805a8a2cdde332498c714cc5642cb
BLAKE2b-256 cb3013fc5132a18e02ea913c088f11c8848f696e3a2f7682dc9898af181956c6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-2.0.0.tar.gz
Algorithm Hash digest
SHA256 61c3d7300be5b432bb9c8f2b9eb573b825dff530ccede7f00eeda457c6042fe0
MD5 0df8878a29240f70229eaaec8591cfc0
BLAKE2b-256 fc84e8dc7366267448c380b8dc510b9fc82b3bdd34b06cd2aa26a392a83c7ab0

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