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.

  • 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 simplified BSD (A.K.A. “two clause” or “FreeBSD”) license. 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-2.7.1.zip (1.1 MB view details)

Uploaded Source

Whoosh-2.7.1.tar.gz (967.9 kB view details)

Uploaded Source

Built Distribution

Whoosh-2.7.1-py2.py3-none-any.whl (468.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Whoosh-2.7.1.zip.

File metadata

  • Download URL: Whoosh-2.7.1.zip
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-2.7.1.zip
Algorithm Hash digest
SHA256 6e6ba17751d0d820b6531e5bbe12b2bd08f0343d839f3ee756c2dfc61946bed0
MD5 12b0d9c717a4f98dca76f053e2ad3abb
BLAKE2b-256 89ee974f6d7215be18954ea3bd4cea952532cb8be6cc51e02603d651a108f5b2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-2.7.1.tar.gz
Algorithm Hash digest
SHA256 ccdf80f268f9b7016e933a0fbf0269f39303798d33eebff2237430fa9db68f8e
MD5 da16bb7c44fa241e6839367d0e9d5f1b
BLAKE2b-256 046992d35d7781edd112df5ec7d9d7205b202ad8a71fe364c2a71fc9b60ec5e1

See more details on using hashes here.

File details

Details for the file Whoosh-2.7.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Whoosh-2.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9ad95d03fc73613c59f098ec69de37e7e017049bec587803b7b5385fa750c8a0
MD5 6a546dce9b13fb8a4649cbe12251cd43
BLAKE2b-256 053a124aad5c90eaea6a5d1a38b7f90e6cf34f5a236967d7683cde0d35f8b192

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