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

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.3.zip (1.2 MB view details)

Uploaded Source

Whoosh-2.5.3.tar.gz (1.0 MB view details)

Uploaded Source

File details

Details for the file Whoosh-2.5.3.zip.

File metadata

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

File hashes

Hashes for Whoosh-2.5.3.zip
Algorithm Hash digest
SHA256 baa386b112c22392a5301d81d0b1f6974d222f9d73d1ddc990ad6c0d58dbfc8b
MD5 cabb280d523f97613bea8825be974ae3
BLAKE2b-256 70b7227b37f153063cd93d9a05a8d79d8deb715148f195911ce2ea0ba711a550

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-2.5.3.tar.gz
Algorithm Hash digest
SHA256 b95cb28a3a415adfbc4bbc5f27c1449da28571a718e2710bdd2c4a9d5882623b
MD5 fb3401f54f6b49ce5ea49f62d4905917
BLAKE2b-256 26bf381708b91c201d9ce501bedc55a5246fd4908b8a618c3ec30d0967b92c4c

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