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.

  • 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.4.1.zip (1.1 MB view details)

Uploaded Source

Whoosh-2.4.1.tar.gz (938.4 kB view details)

Uploaded Source

File details

Details for the file Whoosh-2.4.1.zip.

File metadata

  • Download URL: Whoosh-2.4.1.zip
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-2.4.1.zip
Algorithm Hash digest
SHA256 79ae015025f174a0712ba67918ea5a28ecb9d60eec156fe5c4d2cec6b9634cad
MD5 92b15843e2b0496f29956649c8ce1a0b
BLAKE2b-256 fe8f8da7258cea516b995e67e906b6782ef707c0e6cab90cd5d07bf9dd1b69f3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-2.4.1.tar.gz
Algorithm Hash digest
SHA256 466c377ae8567aed86abef401774ddb27e80055ac34a33bd0e12d6b7db69a40e
MD5 dba02916b83c64d35291bc327f39ecca
BLAKE2b-256 556cc2ef99a8c851010b0700bf3ee036184911762b1146177be543fe17f39d52

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