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.3.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-1.3.3.zip (541.8 kB view details)

Uploaded Source

Whoosh-1.3.3.tar.gz (490.4 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.3.3-py2.6.egg (485.4 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.3.3.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.3.3.zip
Algorithm Hash digest
SHA256 a86cf93e9b8395eda9c5dd5385aaf8875076d5cb1e3b43e67223de7a619e27bf
MD5 65c4d171d7398035c4ec0562c972f652
BLAKE2b-256 b6b72820632cd2a2c34ab59cf78fe42898148eb5feb414a217905e83a936b847

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.3.tar.gz
Algorithm Hash digest
SHA256 7883152ff76de42c17516ab26bb12e9fe43478a19853937bba1beaacbc22e3cf
MD5 506e123473b2ee321028a2f5975c038b
BLAKE2b-256 f39513fedb8f800051e7e3eb92ac5db9c398d9300ae0244296ecfb2bdef5c1de

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.3-py2.6.egg
Algorithm Hash digest
SHA256 d9eb69dbccad2fe5db6f983fb65f3b55bcdb4a4bc2f7baf99ec3ef12c2677be9
MD5 6bc7352e3f0618c8b4122e112411a360
BLAKE2b-256 766d11ef0ef4e175c35733f84e6fb9ad1ddae7a93d44b4f6d3759e5872cff8b0

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