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.0.0

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

Uploaded Source

Whoosh-1.0.0.tar.gz (275.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Source

File details

Details for the file Whoosh-1.0.0.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.0.0.zip
Algorithm Hash digest
SHA256 0b4574a8032aeb716cf9d5aacdaadb8b8bed61002c02069fa03094edaf0ac6f3
MD5 35aba4beae4091b6d14e2bb3358ac8b6
BLAKE2b-256 d211b480394cf86928b95955df2608ac814f4e01b5544375d4e690c789d3c6a0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ad23d4b754f131dfae4e3a5aa3dff33d9f2dbe8743980ffa91d49f863b2b9cb2
MD5 180fe26158d495e4ad2060f934390798
BLAKE2b-256 15cc7d773109c4558ca13dc84b72c054e3f94102afe651808fdc0e865e8efc33

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Whoosh-1.0.0-py2.6.egg
  • Upload date:
  • Size: 438.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Whoosh-1.0.0-py2.6.egg
Algorithm Hash digest
SHA256 30f344f3752d2810f4870ff3d998cefb6034964b03de406d186f814cb506cbbd
MD5 c6d9e433cb4018e4b1120e30715f7b66
BLAKE2b-256 58cc0ee938f4bc7bf54118d214e7dfe136e17be4ce092e0ac26b069c2f7b5d86

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