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

Uploaded Source

Whoosh-1.0.0b9.tar.gz (256.1 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b9-py2.6.egg (494.2 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b9.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b9.zip
Algorithm Hash digest
SHA256 9af58e535bbfa1122b81a5d168b9e177e07309f0d2d66c246eccad978c94a1cf
MD5 136f5f8cd092d456e1ceb4194915a70a
BLAKE2b-256 79cfc26d49b54c82089333666703009c7ff6b0563b429fab319628a1f62d91cc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b9.tar.gz
Algorithm Hash digest
SHA256 fb5532de1fa44887163d29afc8743e9c382b455eae379bddb85a620131c534b4
MD5 de4c65beff00d91270bc2f560d6e2667
BLAKE2b-256 d87940acf5af300dd58c84c225e64b046a6e4d4c5e33ae0bd725af87a73fa7fc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b9-py2.6.egg
Algorithm Hash digest
SHA256 62b9c0700708d8d0b9c7d2542102ddc7bc99b291d42108718a7e706acda82232
MD5 3ee7f91f50393f6c33a6165e282f26a8
BLAKE2b-256 562fc56e9e70bb7f3848b0caf35d273017fb6708897116b07dab566b58c0efb6

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