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.4.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.4.0.zip (1.0 MB view details)

Uploaded Source

Whoosh-2.4.0.tar.gz (923.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-2.4.0.zip.

File metadata

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

File hashes

Hashes for Whoosh-2.4.0.zip
Algorithm Hash digest
SHA256 343e4c75d5faff6b958e452480da4355b6323e207331bed2d92ec3ef74b1079b
MD5 7003aa9850492d99ad83722ee97da45b
BLAKE2b-256 3b9f989b89b393a7e98d7c5e6d5c2ea6d93de0036988da42a5cd53a309483210

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-2.4.0.tar.gz
Algorithm Hash digest
SHA256 12d55e0a844dce25a5764b1b0dedcc12fe91d2f5082ee1015fcc693acdba9198
MD5 87d7d30c225e5c35d2d9ae6a14f8cba5
BLAKE2b-256 da130365c35089468e2dcffc53e9763202f26da2318496f6e6c3de9dbc41686d

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