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

Uploaded Source

Whoosh-1.0.0b12.tar.gz (259.5 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b12-py2.6.egg (405.8 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b12.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b12.zip
Algorithm Hash digest
SHA256 343574f736b84d16e8e2ede828b5ef0e1f75e73c1137c9b33d371ed33486d584
MD5 1dc61084b06ce9252cc1d84bd88460e3
BLAKE2b-256 fa45719bd508bd5680fa077be689dee1cda1871894fb5f1225975ab58e88ae40

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b12.tar.gz
Algorithm Hash digest
SHA256 5d4bc6123c4f9ced83ce4085216dffa2dfaf2b4705055800171fff1e1ec934b8
MD5 542ae5d5f5d22a0393b616abbe152695
BLAKE2b-256 1c5e67f8aeac1aaa89284a095835196af05b38c5f0c9ac9c2dac96788a002070

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Whoosh-1.0.0b12-py2.6.egg
Algorithm Hash digest
SHA256 d5039c6f6a8e9ebe9ca2c34abc7f384fbfb74460885e8acd5a57bf69c41f6a47
MD5 b69c96991adcd622459c48e4277cb519
BLAKE2b-256 57f233eb276ed9b681dae3cfe9f4ee8e2d2b39c0b74b0d5d4d954ffc38c3641a

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