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.0.0b8.zip (304.3 kB view details)

Uploaded Source

Whoosh-1.0.0b8.tar.gz (255.6 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b8-py2.6.egg (493.5 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b8.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b8.zip
Algorithm Hash digest
SHA256 8228e83b9df226bd20c8f8cdc00c46be84cd9b45b02b58fef8bcd69720c95b61
MD5 3c4dad6d07bf11818127a81408d7bf27
BLAKE2b-256 5febefe1394b60dedcd6f892c1851b22d1811ffda123a10a0479683a355ad9df

See more details on using hashes here.

File details

Details for the file Whoosh-1.0.0b8.tar.gz.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b8.tar.gz
Algorithm Hash digest
SHA256 5e6036326606fd57ddb28c7c4991eb623e3cea0f4c53be691c2d7675e22405c4
MD5 4cf0ad3c7374ae06ab66149ec9e5b3a5
BLAKE2b-256 7d8ef027a0f32285d946e6f1417e03dee6b374860a872ef2db619eefd2243a00

See more details on using hashes here.

File details

Details for the file Whoosh-1.0.0b8-py2.6.egg.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b8-py2.6.egg
Algorithm Hash digest
SHA256 902cd65d380c30e890ad4dbdc74a27128221d681ed7d228c573b2da86b8b21a0
MD5 6d7d3c8d032dfee306577e4738097eaa
BLAKE2b-256 d162d377d2648bf6322a66661ac5db3899a8f4f581c766c2f710d01838bde252

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