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

Uploaded Source

Whoosh-1.0.0b18.tar.gz (272.8 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b18-py2.6.egg (432.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b18.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b18.zip
Algorithm Hash digest
SHA256 2b908fba07a994f9cde1117e759ecba364f21767f3bb036decf3ccfe1e845512
MD5 a80456b4e41eb61e5dbb6d5ef197f945
BLAKE2b-256 c3522bd94b87a9f0b62bdfb5fac2d8d93430ed6ef858c18ab3c72491f6157e15

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b18.tar.gz
Algorithm Hash digest
SHA256 f158e76b60c7c9ad2986d54b3b4e7eae42d363fef598bef6fa4a07a783f3b6c0
MD5 c16c2f237f7e095bcda23f9130dbd75e
BLAKE2b-256 6e9db7e32ffbee1e8212949316d103f45057e946eea2e5a55a6ec7633aed28ba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Whoosh-1.0.0b18-py2.6.egg
Algorithm Hash digest
SHA256 39c28cd4597b32905c282673c15c83ed11923519aa8d31424686597ddb902298
MD5 b62df6a55bc24891500211de03e59ee9
BLAKE2b-256 1009ae9cdd7cd156560ce3517e3954c13438fb1dceefe12e274fdebba7cf0f24

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