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

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.2.zip (541.7 kB view details)

Uploaded Source

Whoosh-1.3.2.tar.gz (487.6 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.3.2-py2.6.egg (486.0 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.3.2.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.3.2.zip
Algorithm Hash digest
SHA256 48d25f77ebecb3b2639a1488bb42c24ad9cc0343aea42a40fabf97a13840d6b5
MD5 eeff00d63ef63b9ae692024329e65deb
BLAKE2b-256 1433791df966e0052987a9296c22c469be7d6f2fec2ac8ad255c332510da8c95

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.2.tar.gz
Algorithm Hash digest
SHA256 26fc0eb060e4e3ea47dcb6f7baab2e24ca99221e79b93456d9c2ea448f68eb9a
MD5 40604bfc548a9ebb3ecb0c86a654414c
BLAKE2b-256 35017e380508ed6483470e4c40f95316a7620ad6ffba7c8a52285fd304da034a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.3.2-py2.6.egg
Algorithm Hash digest
SHA256 4b8cf172296a3900100cd478c6b2b9d7a0bba3d1c3d7fe2430ca4bdce7ccf885
MD5 3e18c6602550e8bab204a918b91a3235
BLAKE2b-256 0bd789799ae275c973e04d5a342f2883739169fb79b22e431c16d203b737af60

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