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

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

Uploaded Source

Whoosh-1.3.0.tar.gz (489.9 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.3.0-py2.6.egg (484.6 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.3.0.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.3.0.zip
Algorithm Hash digest
SHA256 67914a4c0fb2f7bf01f6975be593a752dd94e507d7b43f53c505ed65f3a7b90e
MD5 859473ffafdffd0cfcb784f9bfd67b1c
BLAKE2b-256 47d1103caea86e901c4a376528c192b1fcbbe9fc481f2104eb0bed5ad37bb036

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.0.tar.gz
Algorithm Hash digest
SHA256 53d3e424acd02b356ec0dd0bbd1e328216a10b8f36bc53d2bfca5ca838ab7966
MD5 e930649748c522805a3be0ebeac2c3ed
BLAKE2b-256 611dbd4fce71ca5b64306192f9b7057b5ff211845583ddb0dc2d05014a507ba7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.0-py2.6.egg
Algorithm Hash digest
SHA256 9cd04462f8c8bf52257a6d366cdcde08eaa89003771babbe2ed6e2c7d5820b71
MD5 d0c2d42a367b224c3773631476b50d0f
BLAKE2b-256 60f2b6abc9018779d994c4a0716c58b804a539d0174d927b7fb8151e8bab3f8b

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