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.5.9.zip (576.3 kB view details)

Uploaded Source

Whoosh-1.5.9.tar.gz (515.7 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.5.9-py2.7.egg (555.6 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.5.9.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.5.9.zip
Algorithm Hash digest
SHA256 0b9a765ccdf78a1418fe831ef923181d6811a4a77ef9e11b5627173df76dd1ef
MD5 4da09bae2b2f9aec01c1737d353c367c
BLAKE2b-256 3f4c2ea6c6f1f0748c32201cd7cca2fee3c53253953aeb17e052a6ec55e4ac56

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.5.9.tar.gz
Algorithm Hash digest
SHA256 8e9a8aad9def7ceb0558623535f5b90b0e5038988d3fa7c35de45d690408999f
MD5 a767ee4582fa4465127295650ed2f3f1
BLAKE2b-256 e63690af86e646267f7d0b3a652d7fc7d20af626ac0922f2d8653627bb4cf378

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.5.9-py2.7.egg
Algorithm Hash digest
SHA256 124445e818ce46e8dc4669eee014c9e6d6978c6f1082b97985c2ffb8a2d365d3
MD5 1642ef5e9ad1f0704bae4cbeab7b60d9
BLAKE2b-256 18d3c10fe84ef60011b01e020c10283167d93cb15282589961ef081a0e784d91

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