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.5

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.5.zip (544.6 kB view details)

Uploaded Source

Whoosh-1.3.5.tar.gz (493.3 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.3.5-py2.6.egg (488.3 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.3.5.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.3.5.zip
Algorithm Hash digest
SHA256 59cefff288a05aafca810405b124ba445161ad06c1916fd9dfb7ce25ce68fa28
MD5 e0a5ac75b31647c5ccebb510f27f2c43
BLAKE2b-256 cee7a6bd8bba7f4bf8d94809006adba1cf2bd2b7aebd9535c48f63542a6a8a22

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.5.tar.gz
Algorithm Hash digest
SHA256 6cedaaccab3d7ece269de3caa2afd7d0873e33fb9ef769bea54a8a7638049d9c
MD5 43e86a504280a29e042122ab0c4de3f3
BLAKE2b-256 546872cac3730177706aa59c4d4417e94ab41ce9c949a2f0d9f018a8bcb26561

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.5-py2.6.egg
Algorithm Hash digest
SHA256 36b5869d037b1cc21e8f9eeaee51b1364e2c80eda69e8a4e11617995825a660d
MD5 90bf59df56754e7a443f1b80efccfe4f
BLAKE2b-256 504a4326872cb00da9723f64d9fc69083ae4b0b5a778d643eaaa9735baa0477b

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