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-0.3.18.zip (297.1 kB view details)

Uploaded Source

Whoosh-0.3.18.tar.gz (254.0 kB view details)

Uploaded Source

Built Distribution

Whoosh-0.3.18-py2.6.egg (438.0 kB view details)

Uploaded Source

File details

Details for the file Whoosh-0.3.18.zip.

File metadata

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

File hashes

Hashes for Whoosh-0.3.18.zip
Algorithm Hash digest
SHA256 3a3ce5eba2e0f3d61f75575f276966fab41eddcf395043962791aaf12047e11b
MD5 2b06badb2aab294cd5d326068c54bc2d
BLAKE2b-256 e481ee3085265920d2a9b16fcad5d72023c4e2040fdc46a2d36db20e96a91a60

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-0.3.18.tar.gz
Algorithm Hash digest
SHA256 29bfbaf8ad97308c6843a70671ec0d291a92349b3e5ccc99fc87024f7bb82db0
MD5 ff5a6f207b2c18989fb16f2e47a4b404
BLAKE2b-256 7b51f9970fd0199437d625a59de8e46f6a4cc46c60faf5de2a1eb9832ef61606

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-0.3.18-py2.6.egg
Algorithm Hash digest
SHA256 45b5069e7cdb937743cc1c946c73bdc9c80a7b0d74b284521b502c89b0934ac4
MD5 f40e5bac33ceb25710afa00e4928f5e7
BLAKE2b-256 cb60734399df21f33691aac0eb9fb9b729982e5c2bddde736a6e4414bde937fc

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