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

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.7.7.zip (636.5 kB view details)

Uploaded Source

Whoosh-1.7.7.tar.gz (577.0 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.7.7.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.7.7.zip
Algorithm Hash digest
SHA256 3697b6cc9e20770ae5ef04553581a076da26b767456d7203dea746e7d5dfbc24
MD5 1b615ea45aa6374baf43e3a1af835274
BLAKE2b-256 4ca314dd5f41918c662963ec5b84010f81ce0cb051b2b4529e5f7f0792f4774a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.7.7.tar.gz
Algorithm Hash digest
SHA256 663a2c05e1d3b67570564fe7595ffe20a9e2a05c14fca989804a4392e9735eda
MD5 19fc3e644e729aa3b74b70b8344fb02f
BLAKE2b-256 6be4c02a40afe5c9f3c5782fdcd240b29860e55d137add8216810eb9bfc6f48b

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