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.

  • 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 simplified BSD (A.K.A. “two clause” or “FreeBSD”) license. 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-2.7.2.zip (1.1 MB view details)

Uploaded Source

Whoosh-2.7.2.tar.gz (967.9 kB view details)

Uploaded Source

Built Distribution

Whoosh-2.7.2-py2.py3-none-any.whl (468.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Whoosh-2.7.2.zip.

File metadata

  • Download URL: Whoosh-2.7.2.zip
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-2.7.2.zip
Algorithm Hash digest
SHA256 0f72a49e02e2669a50f1ecaf0364fe0451619473c404efeca9914dd878de73f2
MD5 a558943bd52c15a1e4491a29d74b1f91
BLAKE2b-256 1275425195802b32c28b686516529bcc19f01a4ad8ec38524fda119c5cc76867

See more details on using hashes here.

File details

Details for the file Whoosh-2.7.2.tar.gz.

File metadata

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

File hashes

Hashes for Whoosh-2.7.2.tar.gz
Algorithm Hash digest
SHA256 baa11544c788ddbefc8fb48d900862fc02d48cf65e0c99f8f1984c281abad7e1
MD5 14175f7adc0d1c8556fcca346f9a773a
BLAKE2b-256 9aac08b11b5cadb1fdcf329032a1dffc30c051e13008bf6f548e2f0185d09957

See more details on using hashes here.

File details

Details for the file Whoosh-2.7.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Whoosh-2.7.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3581985dff5692f6895837c878c2372dca3ad11a183db1360363852af544af98
MD5 66bdfda000563bdecac6b406722836ab
BLAKE2b-256 3fa4412aad3e3966ee9e8cc97a29d33d991552479ea39272eaa972773bd44b7e

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