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.4.zip (526.9 kB view details)

Uploaded Source

Whoosh-1.2.4.tar.gz (478.1 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.2.4-py2.6.egg (465.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.2.4.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.2.4.zip
Algorithm Hash digest
SHA256 8cb4b9a615b3901ba7f5b0bb4aa95a447a253499f95537028a485a770ce2b44b
MD5 1531b21be04c8e4f1480498ecd576c00
BLAKE2b-256 005d6a3983ae3a0ad1fbb9928cee49ab25ae1cdb27837a458172a353bf3e79af

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.4.tar.gz
Algorithm Hash digest
SHA256 10406c2ec1f716e96874894b4327a29d705c31bd2b7b7b4bcc80512f09608598
MD5 a35c31603b90d144bcfd2faef460d3e8
BLAKE2b-256 f4b1c6f16ea0aac6844bb391f33706b1b204831bd94bd208b007377b42714c37

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.4-py2.6.egg
Algorithm Hash digest
SHA256 dad049b3c856148fa7462d021da39f7cc6097d9717592516c57acc5d5f6d47cd
MD5 a9af635af4280aca0195365175c8dd9b
BLAKE2b-256 fcb616cbb6c7b0f5c9d941d5c0551ee169b1abaeb37d34de08730f2134c403a3

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