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.0.0b5.zip (211.7 kB view details)

Uploaded Source

Whoosh-1.0.0b5.tar.gz (184.8 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b5-py2.6.egg (479.8 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b5.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b5.zip
Algorithm Hash digest
SHA256 d028c1ec2ac8f5b3f7db08fcf4d715f00f54d1cc81543574e6341aef7b29f176
MD5 b8c2c020c599a1686eb98f1e176dcaeb
BLAKE2b-256 936d88734b663ce6fc66b7efd1b2ac5cc6727b45c096b1517b9609def4207a4c

See more details on using hashes here.

File details

Details for the file Whoosh-1.0.0b5.tar.gz.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b5.tar.gz
Algorithm Hash digest
SHA256 13f4f754b5019e1cc252fd510c2a43c403c1c533a393bddf5e96dcb76948983e
MD5 e92d3494fa4a3111b412afc7a0a43a0f
BLAKE2b-256 b76453f7bc4cc07c29eb3edb951573fe710e6220a763e072576bfbfd23f280c7

See more details on using hashes here.

File details

Details for the file Whoosh-1.0.0b5-py2.6.egg.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b5-py2.6.egg
Algorithm Hash digest
SHA256 136386d120c88cea329bae671ef4934563e8defcf4069150311d93c4f62e97a9
MD5 f0a16ec6cbc4a52f7dd7c4b3a3e2a620
BLAKE2b-256 eacaafc1feefe23a8f54ccb26c3e3afeca696d88523cb23d59eaf8f1fd025c0a

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