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

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.5.6.zip (576.2 kB view details)

Uploaded Source

Whoosh-1.5.6.tar.gz (515.5 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.5.6-py2.7.egg (555.2 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.5.6.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.5.6.zip
Algorithm Hash digest
SHA256 88578472f22ec3a896b3878a56b10ffe3067539dfb3ef14fa673625ce48becba
MD5 7163c84d04bfe016b012cd3ea7bed804
BLAKE2b-256 7a7887b22999653ec8c2143392b8364036e457e4dea1605f7c34de26622ce370

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.5.6.tar.gz
Algorithm Hash digest
SHA256 1c2a8984f653a608b33bc127864fe2026fbd1a1b3834b00a4cb865c344085fd1
MD5 39de658b0ff3581e4dadaf6dfd766ded
BLAKE2b-256 6a81dfb202b290b2b53bc38e003a1de5d55f76573da43ae72d7afeb59e0f9af5

See more details on using hashes here.

File details

Details for the file Whoosh-1.5.6-py2.7.egg.

File metadata

  • Download URL: Whoosh-1.5.6-py2.7.egg
  • Upload date:
  • Size: 555.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-1.5.6-py2.7.egg
Algorithm Hash digest
SHA256 cba6b7f068fa8bbacbe4980b87e64237711e76090ba2798ff27fdf04dbbc73bc
MD5 53426412ba60e23691d5980803e8b8f6
BLAKE2b-256 8d399f8373dcaf7248ee048d27009a947367d2bdc34b8d8887aaff06f5a2a9d3

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