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.1.1.zip (520.3 kB view details)

Uploaded Source

Whoosh-1.1.1.tar.gz (471.9 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.1.1-py2.6.egg (454.1 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.1.1.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.1.1.zip
Algorithm Hash digest
SHA256 f5da310416f527fd64e74fa1d2c7dd28a3fcb98bbaefa27e104af69c670493c1
MD5 d7f198ebf32619d05f995d78e46fb488
BLAKE2b-256 be2b3381256a5f344adeacb5631772e4b9e5a469ec4cef9e3a59dcc9411d4b02

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.1.1.tar.gz
Algorithm Hash digest
SHA256 2e260efb78a92aefb6dd8413390e218e660c9aeeb0f05cb2918e26ca5e29ac4a
MD5 985848b304f0af8e4a619ceeeed28177
BLAKE2b-256 1a73ea7975acae10c227a8b15292d0933a867acc2be3936f9d03e1f708d5efca

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.1.1-py2.6.egg
Algorithm Hash digest
SHA256 3cdfaaef994e00a4a65282ad69d69bd94fbc15215bda0161666829b7d96a8c13
MD5 acfd1612618adf360f48c1c4d65ea570
BLAKE2b-256 b57c725fea294582f3b74b912d729da6298943d59c2c3c6d794e39b03c885f9b

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