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

Uploaded Source

Whoosh-1.0.0b7.tar.gz (255.2 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Source

File details

Details for the file Whoosh-1.0.0b7.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b7.zip
Algorithm Hash digest
SHA256 ac7736a7ad8cbee3eef2ca03f19868b9f048758cb6d976687b2c95031d2aa66e
MD5 3934bac0b368f46a55c1af4905736644
BLAKE2b-256 990e1d5e31ddbedff95a02a17564d7a335ef41541832a9d74ff22cd79ddd4892

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b7.tar.gz
Algorithm Hash digest
SHA256 40a4e166ad0fb5b1f50bc836e76b31a63790343d5352044357bcc4830469cd7f
MD5 f45a0200a2ed172f7a6b292c87f3fee7
BLAKE2b-256 3a9552bd63e486f071a2656a17ad8c3d2e2675e0054ad15bb212dc8b6aac7068

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b7-py2.6.egg
Algorithm Hash digest
SHA256 126fd32f691321a128f4947ad3d673b1d201e1d6ec71fca02556b5b594ad9680
MD5 cc8589aff65aee0bd34eee3e6c65ab3b
BLAKE2b-256 2179d8720375b0e49e6a0519bef464af9e818843322266bf45b452683b098940

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