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.4.0

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.4.0.zip (546.1 kB view details)

Uploaded Source

Whoosh-1.4.0.tar.gz (494.7 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.4.0-py2.6.egg (490.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.4.0.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.4.0.zip
Algorithm Hash digest
SHA256 25550bb87e69c403b4e6302117dd482b27d2f14dbd1b67edbe542a7449642507
MD5 1bf16023aeaa6c8c5045f9b4be457b96
BLAKE2b-256 721bbc0c32761dbdeba874da98ce1d74fec8a8643256f5eff7dd6ae1b3321ffd

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.4.0.tar.gz
Algorithm Hash digest
SHA256 ffbc4a64671a22ced9953d837255abd9a6a59e138b02585e8bd48b637ad41b77
MD5 d54915b2e6659b2c101dc2852ed12447
BLAKE2b-256 ad2a5d27232612941739bae2619ee7ff63ab03fad88155c61f663f49580529b1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.4.0-py2.6.egg
Algorithm Hash digest
SHA256 7329f46d71707389ac03571679430367f66c1d2774beef059225748d531994eb
MD5 03f6c22e29b4928e0f4273c85b797476
BLAKE2b-256 3df2a1f62cdec70fa8e0273dfed1b856ced90722e338a45e742a60e640d427f1

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