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.5.zip (527.4 kB view details)

Uploaded Source

Whoosh-1.2.5.tar.gz (478.6 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.2.5-py2.6.egg (466.8 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.2.5.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.2.5.zip
Algorithm Hash digest
SHA256 1e967d69abb2c221238d0d7c6618a3a15b864afdd38b63e488a8ce246b7cfac6
MD5 4b1b4b7f534d6c33cf73d1c1b0e6364e
BLAKE2b-256 1ca43afa07ee4bb91d4aa2a3e71d3079720389b53f498c52acc472c0718d506f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.5.tar.gz
Algorithm Hash digest
SHA256 019259e79b8f53aeddd3e83e755db5d4a1f734327e0999d055659c749f508dee
MD5 ec8e4337f037309f4baf913c736b781d
BLAKE2b-256 e5d00dedba2f308e3f325fb497b8496130f95960e6493819bb7ef1d0d9c9650e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.5-py2.6.egg
Algorithm Hash digest
SHA256 09d70a31cff2a87218312d2c3e0dbe8f7f5358053c264970e46ae9a67d31b0cf
MD5 510501253b8c000119e2df52a0db439a
BLAKE2b-256 06e3fd1ff6116a3839cb7a65a568b2ce916dbc014275ef19c5c3ff5cbbbee304

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