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

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.6.zip (527.0 kB view details)

Uploaded Source

Whoosh-1.2.6.tar.gz (478.3 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.2.6-py2.6.egg (465.8 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.2.6.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.2.6.zip
Algorithm Hash digest
SHA256 b206667b280925d9c13ed4bf0276e9ccfe875553e135876acdb6cdb63af24f51
MD5 ba8f0454b711294a8cc05014985f3acf
BLAKE2b-256 3719b3b5b329725a843e486413c2faf5445ed90e819ca98a534e47be5a0efaea

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.6.tar.gz
Algorithm Hash digest
SHA256 540ae65efd9992aabed17f6208196ed98814ad28dc121e2edc0c352e7b8b5d01
MD5 718e57fbd0d97e94fbecdb131a520a0b
BLAKE2b-256 acb5230e63c56357fd6803da328df1d5a502834e3b351e7b56619d5c54204618

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.6-py2.6.egg
Algorithm Hash digest
SHA256 ace60cab65146a30f4d7fdebf8b1a4e445233bb4bee8dae73028642547939655
MD5 a84236a3a65c2c5860ddfb79f516810f
BLAKE2b-256 76a1212e53d896341b6ee2f81ad9020dd2ef37cf33d764c43a396d2a97aa76cc

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