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.2.3.zip (526.5 kB view details)

Uploaded Source

Whoosh-1.2.3.tar.gz (476.0 kB view details)

Uploaded Source

Built Distribution

Whoosh-1.2.3-py2.6.egg (465.7 kB view details)

Uploaded Source

File details

Details for the file Whoosh-1.2.3.zip.

File metadata

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

File hashes

Hashes for Whoosh-1.2.3.zip
Algorithm Hash digest
SHA256 68b4697616bbd32fbdec92ffaa4369376e913ee49532ebb7ec19b4e1ad76e8df
MD5 0d874cda647790f0638477786d8cc6b2
BLAKE2b-256 a4b9090711f40842eece8af8eb82329530f07ed708f74c9d256605f1c373c541

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.3.tar.gz
Algorithm Hash digest
SHA256 0d00279f78ad74b8a7aa15bed4de2020147c3473a1598f46566b92747e4b0ae0
MD5 2f1619166bd49b9fccb948caa1ed9d7f
BLAKE2b-256 589081e780ced96805a0333d32fa94462667f329fffdb90d9613b0e85b76ab34

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Whoosh-1.2.3-py2.6.egg
Algorithm Hash digest
SHA256 e8b9803fda92bb77cb17126c9b7ca6d6971530832bc08739f0faf90d6e3231f0
MD5 a77ace61b43a568c7c66a4694258c2f9
BLAKE2b-256 2694e9edf5735391771e967fd7b32f067b88be09ca46da0bf17241b0aa3a555c

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