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

This version

2.5.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-2.5.0.zip (1.1 MB view details)

Uploaded Source

Whoosh-2.5.0.tar.gz (957.0 kB view details)

Uploaded Source

File details

Details for the file Whoosh-2.5.0.zip.

File metadata

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

File hashes

Hashes for Whoosh-2.5.0.zip
Algorithm Hash digest
SHA256 da28cb4cea9eceaa67f578ad79a84f5a540f12ae8006731ef709ba555d19da7c
MD5 6779219fa833b506d592094cabf9f97f
BLAKE2b-256 91414641e39cb6e8bc6d1f4db133f87649bc516fd9d55cf6c65b2534f2b42050

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-2.5.0.tar.gz
Algorithm Hash digest
SHA256 7f551f39056a8b754f204171b80e708723f8bd939caaa478f6babfea62428472
MD5 0dc26a070125ad2fb4af9fee26ccf9c1
BLAKE2b-256 01f8277c571e79e271c3b546a75866e8953ebd28c58a2d5b951247790415dd90

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