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.3.zip (574.6 kB view details)

Uploaded Source

Whoosh-1.5.3.tar.gz (514.8 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.5.3-py2.7.egg (550.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.5.3.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.5.3.zip
Algorithm Hash digest
SHA256 e66a22f66819fa20492ec19674c677654af2dc110fbf0e278fb440fd7925c5c2
MD5 b85fa9159d08db08038a1b7f4db6f820
BLAKE2b-256 f9e404b8eb749e4cc932dbfcefa59c8d781a7a0b2fc38e2781b29eb5f58fd8a6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.5.3.tar.gz
Algorithm Hash digest
SHA256 7480103c0a70e77f76de5b916dc3ac6899b626289de29c81b28aa28907bd7e7c
MD5 10b7b6697e65ef8098cbb2fe724a6cef
BLAKE2b-256 eea6c384d3f49db9a96c7a3e0b27475447a493e27b9b6db2faf45f8da15b4a80

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.5.3-py2.7.egg
Algorithm Hash digest
SHA256 d3c41d83f9d3ad6d62ef2d2efdb52cfde39288ed7f73c6fb43e059b2595a5430
MD5 e83826be139a72ab72ded99565b334cd
BLAKE2b-256 db53b8ea5ea71c7572b04aecef324b88079facedf2c7bc8a4211daec7baa0cad

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