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

Uploaded Source

Whoosh-1.0.0b15.tar.gz (258.8 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b15-py2.6.egg (408.0 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b15.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b15.zip
Algorithm Hash digest
SHA256 a3397cf6ce0d96738b40be02c6c8352754e6d9c6ae229426bd0097eea54856a4
MD5 497ebfcd793486eca20b67a7ae5901a6
BLAKE2b-256 72d5d9bfc079811e32007c9304cf21d69db9a9368efa72fb5f16f56814d08cb7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b15.tar.gz
Algorithm Hash digest
SHA256 0fb3d8447d2bc4d6ce9cb3b4f952f104ff00f3fb64a44d57e9992ee25639079e
MD5 af795b92110ee2c5dae15cfe7d7405ab
BLAKE2b-256 381c6e8908a386d4bc17739427641243ea8aeade043b2c42a7da2bdfde73c51d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Whoosh-1.0.0b15-py2.6.egg
Algorithm Hash digest
SHA256 f476198a0ed2645e42569e3491a7509bcd7601a9365beef546dc2171ab198a67
MD5 356a605462be9325e64f3a426cf6dc6b
BLAKE2b-256 fc4db96f02a781df637944749ec5cee970b5919613e10f33bad7783f94a2607d

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