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

This version

1.6.1

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.6.1.zip (583.8 kB view details)

Uploaded Source

Whoosh-1.6.1.tar.gz (523.5 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.6.1-py2.7.egg (574.3 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.6.1.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.6.1.zip
Algorithm Hash digest
SHA256 a915bd5d2bba0ba88b2a63a5de63e26d51caacf3954232813e529a2ae701cb0a
MD5 b36d96620d7f91e4e4f99026fb1d1474
BLAKE2b-256 4cc39ebcaf9825ee1c5c098d33695d26b16997a5bd5df8e5cabd56b3bf6d50c6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.6.1.tar.gz
Algorithm Hash digest
SHA256 e39f94ed83bece1ea199d11939acf07b54e9ecfbe6d62f6cdc1fa631342f9cd8
MD5 206b989d9073f32ddd860069fce353a6
BLAKE2b-256 702907b25ddad5e166c95ffdf573c8a6ee94e5349f54fd4f42fa19f06d03f2fd

See more details on using hashes here.

File details

Details for the file Whoosh-1.6.1-py2.7.egg.

File metadata

  • Download URL: Whoosh-1.6.1-py2.7.egg
  • Upload date:
  • Size: 574.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-1.6.1-py2.7.egg
Algorithm Hash digest
SHA256 27bfc012837729f5da73e416cd2a870bf60587f8b6f73735e4f93c3753132dad
MD5 a7a494d6b62160a4a8b88741dba30654
BLAKE2b-256 f83980657677daf2c89abffed94bbe38bbd3b865da79fcbe81af1cd3fcc16a5e

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