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.2.0.zip (526.2 kB view details)

Uploaded Source

Whoosh-1.2.0.tar.gz (477.3 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.2.0-py2.6.egg (465.2 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.2.0.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.2.0.zip
Algorithm Hash digest
SHA256 f65ff38b004f85aceb171ff03b6383f0a62bbe13988fc0e5f2a514ffe072c5e8
MD5 869f938e063958111302008ea9fbbb4f
BLAKE2b-256 417c185e8e0e6689990fd863f069d58e5af0371ed7a3ead55fd0724f794c2d67

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.0.tar.gz
Algorithm Hash digest
SHA256 792e15b6cbfde9d444b3fee826a95763f2fa972f38a709de0ed334afe1bade19
MD5 58dba4bb10cd1b30e5eeda06d8804380
BLAKE2b-256 5de8c618507f3a66fbcfb86f47fa1f8b7c54dab2cb491360429ed0b8f9b460f4

See more details on using hashes here.

File details

Details for the file Whoosh-1.2.0-py2.6.egg.

File metadata

  • Download URL: Whoosh-1.2.0-py2.6.egg
  • Upload date:
  • Size: 465.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-1.2.0-py2.6.egg
Algorithm Hash digest
SHA256 0f4d9080dc62e29f1c349eb7c9b91d5f6394b689c6395dbba34cdf423f4f9d0e
MD5 ce0a2b76ee1d4a14b944ed47dc7a9a17
BLAKE2b-256 4c32db8873e8f2b8daece4ea52628b8f20f27fb094a36942f8c24a8f59a6bf7d

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