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

This version

1.7.8

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.7.8.zip (705.5 kB view details)

Uploaded Source

Whoosh-1.7.8.tar.gz (627.5 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.7.8.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.7.8.zip
Algorithm Hash digest
SHA256 e301129e0b6a01844f40c699191920e5f167b2850ac2408a2162b1951f0539ca
MD5 bc13be3a94777c2b72f03afd80c0a3d6
BLAKE2b-256 136787b23c919d74ae9afd07f53fd3b83501c1d00208ca1dd69be693b3bbad4a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.7.8.tar.gz
Algorithm Hash digest
SHA256 d15f502ff5097f21a6d4bfaf2076e8d226151b1ddd3f5d858ff0d6506efed292
MD5 6ff5c1d07948ac3bb921721cca2a035f
BLAKE2b-256 adc8d7fcf927311aec1c9ca2f6c0a71396c37d6fd4a0842126ec4671ae9e73dc

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