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

Uploaded Source

Whoosh-1.0.0b20.tar.gz (275.2 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.0.0b20-py2.6.egg (438.1 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.0.0b20.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b20.zip
Algorithm Hash digest
SHA256 98b907bf6297112158d09f185777af998b312577dd5d3cca694ceba1d717bbba
MD5 0e07e9689491b56d29a95f61e0e0e64e
BLAKE2b-256 a43900eacd32ad19de8a8073bf24087e1c84ad3b11ae183ac313d54fff22ea4c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0b20.tar.gz
Algorithm Hash digest
SHA256 c6fbc36c45e9776f3f1370838d31fd62d308d870dfac74ad45645141152a9ba0
MD5 b3e0635ce1090faf37ff433f65e55eeb
BLAKE2b-256 813326d2290af6ed4a919efae72118d89cb8033ea23eaa7036aa5c739b1973d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Whoosh-1.0.0b20-py2.6.egg
Algorithm Hash digest
SHA256 e23d2c88959b2462ad44bc3b752f17f436bfdf4fda62aefa87552ae10f328c97
MD5 f8925ac9c7f379591f61a394299385ae
BLAKE2b-256 a08e4dc926e1e541221b0abecbb12a070715934624271975442266a1c352676a

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