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

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.3.1.zip (541.4 kB view details)

Uploaded Source

Whoosh-1.3.1.tar.gz (490.0 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.3.1-py2.6.egg (484.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.3.1.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.3.1.zip
Algorithm Hash digest
SHA256 f4383b78ae6d9c67d0ff01568f120aa495b97f698ab5a0fff2876ab0ea648092
MD5 dc44f9f460247e151ee81ab190cd0ef6
BLAKE2b-256 a65570f030bf61b7a7334f9c6991d96748e8437fe641f105eef68c0f3646de00

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.1.tar.gz
Algorithm Hash digest
SHA256 864de8ff05359ae31ebe49b718bb5327b8dd5f53b7b296df18aeac962849f28a
MD5 455b82b28775479a5ce0bbbe29f6db76
BLAKE2b-256 3968aad412496bb45457f1d43d113a65168e09f2bdb0fb51ae9c88f060f20864

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.1-py2.6.egg
Algorithm Hash digest
SHA256 e1b1f31b9e9d67e679e93e64569e7ced9dab6d7894d173e1b1dfb6e29981365f
MD5 caf1a558cf7064e6297510ee06f7bcea
BLAKE2b-256 80f4d8bba8386bb16e9383efe189624913fd7cb49bee6c8d1d3fc66ff401112c

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