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

Uploaded Source

Whoosh-1.0.0b2.tar.gz (180.2 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b2-py2.6.egg (468.1 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b2.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b2.zip
Algorithm Hash digest
SHA256 c73f1074328ffa1de011f9bdc64a7eb2edb69f480b7ae433039376a395fe9903
MD5 c06a60b3ca2f7ef2580d98e9e5402ff9
BLAKE2b-256 e430ba7ec3a6f21699dd5d7dfbbdba5983ad707c8b140f08a01f78a98437565d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b2.tar.gz
Algorithm Hash digest
SHA256 6d05335ba90d50d571c0031ab1aad6f07a5654996d6a47d40212fb071e70b7da
MD5 635b7798880a1eb984d392596daaf004
BLAKE2b-256 da04717ebb5e329c5da0bbff27db0931872899016ea5e57a5672ab82ac5a29f8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b2-py2.6.egg
Algorithm Hash digest
SHA256 0e83f5b9e31e395f5005341ef10d51639f4f1be4acb95cb5eb5660e8d7f13e9f
MD5 93c912ef81d91b23a2718c989af4e916
BLAKE2b-256 bebf7bef827b52333de5eec534c96eeaba61b12bd6bca2e678682c277829818e

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