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

Uploaded Source

Whoosh-1.0.0b4.tar.gz (185.1 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b4-py2.6.egg (475.3 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b4.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b4.zip
Algorithm Hash digest
SHA256 495d454b517308ce721f6a4fbaf2bfa43ccc1de831c93af18e18fbee09d5fa56
MD5 f98efdd364d77ea11e5ea66c1c858462
BLAKE2b-256 6c652fd6c33b6bf1877f6cec30d1fce0f7afced4eb4536eb3117ae41b58c232d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b4.tar.gz
Algorithm Hash digest
SHA256 5c2e834ea9812164861cd3cb8ebbb33c07eeb28123e3add2f55c19e7f3c039ac
MD5 39e792c318d68c76f82bf70e65863d66
BLAKE2b-256 e04a4b21d68b63eac7d01cc874f291527b303a505e97b534b8123a9375c4617a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b4-py2.6.egg
Algorithm Hash digest
SHA256 8385b0130857ac3b0f8cb488d52cd5b1099f24c11e0e8ac82e1752eb64c988f2
MD5 6fff1cc5253062cb9edd087aab69b30c
BLAKE2b-256 77ddad4729e27bc405f6e6122c4a7d6431adcf234cdd0edd653650545fb1a996

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