PyLucene 3.4.0-1 import
[pylucene.git] / samples / LuceneInAction / README
1
2 This directory contains most of the sample code from the "Lucene In Action"
3 book by Erik Hatcher and Otis Gospodnetic. To purchase an electronic or
4 printed copy of the book, visit http://www.manning.com/hatcher2
5
6 The samples that were not ported depend on some third party java code not
7 available to PyLucene or is related to remote searching which is not
8 supported by PyLucene at this time.
9
10 R E Q U I R E M E N T S
11 -----------------------
12   * python 2.4
13   * PyLucene 2.0+
14   * for the FileIndexer.py sample, some text extraction is handled by third
15     party programs invoked as a sub-process. The code assumes that these
16     programs are on the PATH:
17     - PDF files: 
18       pdftotext and pdfinfo, both available from http://www.foolabs.com/xpdf
19     - MS Word files: antiword
20       antiword available from http://www.winfield.demon.nl
21     - RTF files:
22       not implemented
23
24 I N S T A L L A T I O N
25 -----------------------
26 Before any of the samples can be run, some Lucene indexes need to be
27 created by running 'index.py':
28    - python index.py
29
30 R U N N I N G
31 -------------
32 Each of the files in this directory should be run from the command line:
33    - python BooleanQueryTest.py