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

Uploaded Source

Whoosh-1.0.0b10.tar.gz (256.6 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b10-py2.6.egg (407.0 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b10.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b10.zip
Algorithm Hash digest
SHA256 1e01b84a3a1086e1a487145b58ca54529f9b294375806f4695d24362a4b2f88e
MD5 7a2325d5d2d5a6f8bdcbc4ea54ed63a5
BLAKE2b-256 aa170a628eec0e562f1cb515fc781b1fa9566767c8934aa5da152eb6495a6004

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b10.tar.gz
Algorithm Hash digest
SHA256 4208aa0b37e680a23e53b5acef9ff813f33958f2e20946886682fe2ac78a50f3
MD5 ee8b2047f44db8bc1e77c744b3d3ce92
BLAKE2b-256 b0f51a32b2584c942bd9b15ca23672a4ebb56fa3bb1e5b92bc79a403fa6bde95

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Whoosh-1.0.0b10-py2.6.egg
Algorithm Hash digest
SHA256 65ec7c70600182249104cfe12fdbc82970c77dac013b78f8e3058590e31ca358
MD5 5c260b867b13d0598c63d0c60266e864
BLAKE2b-256 213a74d018c54e927fedc75d3ce14a7f0859a2fcdfef28a9259b99460cbf3cc7

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