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.0b14.zip (310.5 kB view details)

Uploaded Source

Whoosh-1.0.0b14.tar.gz (258.8 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b14-py2.6.egg (408.0 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b14.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b14.zip
Algorithm Hash digest
SHA256 9b9750c2ec7cde5dba03cf5ffc79c8ca9d2ff22d9d3bb5a017f4c281d3d94897
MD5 aabbb70d8d631d6b304532701b39b3f6
BLAKE2b-256 7f8ca8d721c475b9cccdc04a2c6e9f53bcf53449ce02833d151facde2f77aae3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b14.tar.gz
Algorithm Hash digest
SHA256 7ea3e59beb5944a70494ddbe4d28f7ab667c8e3ca8a02e1fdf185011e1279d10
MD5 39c9e2821c6466b914c7601c77bbfcb6
BLAKE2b-256 71057672684c6bdd6c4d3ec87abf49d509601c97a8cf925c00f57cc92f58a586

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Whoosh-1.0.0b14-py2.6.egg
Algorithm Hash digest
SHA256 2de092a845f144e572d77dd4bcca58d763dd14bd8124a82504535083d03045f0
MD5 4e118e35f7f1a6b1316a8348a4a3fd16
BLAKE2b-256 d4245e7527e661af08a8497522c6092132f032198ba1497b458a95a6dbced1ca

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