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

Uploaded Source

Whoosh-1.0.0b1.tar.gz (183.2 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b1-py2.6.egg (470.5 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b1.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b1.zip
Algorithm Hash digest
SHA256 44b7c072aaae03974751d8c1098b7dca7d107e60c5ab45a85d2f8eccb11dfa9f
MD5 9bdd64ad60fa1f3bcd9c8974c47f4177
BLAKE2b-256 b4fd7099ffc1f3c0be023bd3f1ab5991e7fa59e08204bc860b4e44545cb9dd2b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b1.tar.gz
Algorithm Hash digest
SHA256 58195160ee23b48d3cf8b280cba9eda6a1d278efaf6fca3352aa18d26c6f8834
MD5 72c21d73f754f01d23bdcdd41a1b3528
BLAKE2b-256 54955da763b8c14f26a8e1e7d89195776d2980e874071b0aff8f1c796c075103

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b1-py2.6.egg
Algorithm Hash digest
SHA256 9cfb5b58adb4a0afa7573772e6c474d79b5902aea783c5ab8190710da049f0d6
MD5 8d4e9a9dd14eb53a9430d7e73fc96c5b
BLAKE2b-256 8b1c57f56e999a6986008f348d62f36ff8a0e067fedf6db4303aa73475af55d9

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