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.2.1.zip (526.2 kB view details)

Uploaded Source

Whoosh-1.2.1.tar.gz (477.3 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.2.1-py2.6.egg (465.3 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.2.1.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.2.1.zip
Algorithm Hash digest
SHA256 13258046aa748ea424a96900231689def576e848b1c373779fa11a8713ba01eb
MD5 66813a1c3b627c390ef52e8d0de4194e
BLAKE2b-256 e45c698ab41050ad8221609f3eafbbc27a26164514bbfbc366ccf4d66ffa41a4

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.1.tar.gz
Algorithm Hash digest
SHA256 45f666dec9ae9c307d03b706285b6421e19164aca4850dc35e25fb0ab2f9632c
MD5 27e26176e1cb701fff968727de88d069
BLAKE2b-256 acfa8be9a5d7832f48e1e7cd96fa90d1a55a4b5b391b48a6b70ce6bc037c621b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.1-py2.6.egg
Algorithm Hash digest
SHA256 bc9b8e88b3f992a727adc6c37bfbe51eb578d5d958aaca34beff82ea59e4fa95
MD5 8c9ddc708c4856a4daecbae055b06181
BLAKE2b-256 13f6a173674aff7a687e9d3cb871cbb81ed339c4040531cfcf31f6a11857329d

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