Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Whoosh based indexer for files and directories (pure Python clone of GNU ID utils)

branch: master

Fetching latest commit…


Cannot retrieve the latest commit at this time

Octocat-spinner-32 whooshstore
Octocat-spinner-32 .gitignore
Octocat-spinner-32 COPYING
Octocat-spinner-32 ChangeLog
Octocat-spinner-32 Makefile
Octocat-spinner-32 README
Octocat-spinner-32 ws
Octocat-spinner-32 ws-update
= Whooshstore =

This is a simple Python module for indexing and searching files
on your local hard drive. It supports incremental indexing, pagination,
and provides an API.

= Example CLI usage =

ws-update -b --index my.idx datadir  # build the index
ws-update -b --append --index my.idx datadir  # incremental update
ws-update --help  # complete command line syntax

ws --index my.idx hello world     # query the index
ws --help  # complete command line syntax

= Python API =

from whooshstore import util, open_index, update_index, search

# Build the index.
ix = open_index('my.idx', False)
files = util.find_files('datadir', ('*.txt',))
update_index(files, ix = ix, incremental = False, batch = True)

# Query.
for result in search('hello world', ix = ix, limit = 20):
    print result

= Dependencies =

* Python 2.6 or greater
* Whoosh
Something went wrong with that request. Please try again.