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.0b17.zip (310.8 kB view details)

Uploaded Source

Whoosh-1.0.0b17.tar.gz (261.1 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b17-py2.6.egg (407.5 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b17.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b17.zip
Algorithm Hash digest
SHA256 b68e0cd599c79d423f0b041e0684c284051ced4b504136b8eb0174037be63b16
MD5 825f4185a7a08bb3ae9d7527120c327b
BLAKE2b-256 7d74663b1d6737b028e691d2086999af556580b497991721e912a2c3e7d06d90

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b17.tar.gz
Algorithm Hash digest
SHA256 0ee78b5cddb859e595277aab6d8c63bb04a6e9a5e5d41aeffab0fad2c2828ccc
MD5 66deb411a4a97453ca8205297fc56fb1
BLAKE2b-256 2b3a55e08539f8412b1c108eb3de7c3ea152578281e18527c2006e7560f3f46d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Whoosh-1.0.0b17-py2.6.egg
Algorithm Hash digest
SHA256 fcb40fc64172957549a996298104cf4640da24b7d492591b47f581aae83f496d
MD5 dc1768ceed6a47f0313e55c3a345a7d3
BLAKE2b-256 4c6319a97c28fd6252348a0ce8b4e985a6da6477f2042e70129946d494227752

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