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

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.4.1.zip (546.1 kB view details)

Uploaded Source

Whoosh-1.4.1.tar.gz (494.7 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.4.1-py2.6.egg (490.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.4.1.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.4.1.zip
Algorithm Hash digest
SHA256 21f31bffc595ae274842cc68f9f15c882445166917ae8d2af08450eec8bd4421
MD5 d6e01e49037efd1ad5d42872de4ecf77
BLAKE2b-256 11952acbfcec7c25d3baf3c45551c658de5a18c65a6d2f0cde44832338b06578

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.4.1.tar.gz
Algorithm Hash digest
SHA256 915f7c706ababcae89262c345afc3cbc85874291ab9a62a7de30a97f97c6070a
MD5 773297affd16f7e5fcf9eebb745c71ef
BLAKE2b-256 a0695dc0eb6d0022b76173dac7a5fe957751b7ef936c19944fe2ba452790768c

See more details on using hashes here.

File details

Details for the file Whoosh-1.4.1-py2.6.egg.

File metadata

  • Download URL: Whoosh-1.4.1-py2.6.egg
  • Upload date:
  • Size: 490.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-1.4.1-py2.6.egg
Algorithm Hash digest
SHA256 f08b70d23a552e90b19c4412e35fe1492240df41f2e146a128f5584cb7fa6920
MD5 d210629522628e7d127fdb249fdfc78b
BLAKE2b-256 6d131f83dd8816c552feba1956534a0bb260528125b52beab1e8e3f4aae5a7cc

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