Table of Contents

  1. About
  2. Requirements
  3. Download
    1. TurboLucene Downloads
    2. PyLucene Downloads
  4. Installation
  5. Documentation
  6. Limitations
  7. License
  8. Bugs
  9. Mailing List
  10. Subversion
  11. Author
  12. Thanks
  13. Alternatives

Welcome to TurboLucene

Note: To file a bug report, please login as guest, password guest.

About

TurboLucene is a library that allows TurboGears applications to use PyLucene for full-text searching. It features a simple interface and takes care of all the nasty threading issues that exist between PyLucene and CherryPy (which is used by TurboGears).

It now also features multi-lingual support for Czech, Danish, German, Greek, English, Spanish, Finnish, French, Italian, Japanese, Korean, Dutch, Norwegian, Portuguese, Brazilian, Russian, Swedish, and Chinese, including pre-configured stopwords for most languages.

You can see it in action at http://krys.ca.

Requirements

Thanks to setuptools, TurboGears and it's dependencies will be installed automatically, if necessary. However, PyLucene must be downloaded and installed manually. Some pre-compiled PyLucene binaries can be found here and on the PyLucene website.

TurboLucene is not very demanding and may work with earlier versions of both PyLucene and TurboGears, but other versions have not been tested.

Download

If you use easy_install you should not need to download any files manually, aside from PyLucene. However, if you need them, the files are below.

TurboLucene Downloads

The current release is version 0.2.2. It should be considered alpha quality, however several people are using it with success. See the CHANGELOG for a list of changes in each release.

MD5 checksums are here.

You can also download the files from the Cheese Shop.

All previous versions can be found here.

PyLucene Downloads

For your convenience, some pre-compiled PyLucene binaries are provided. If the one you need is not here, check the PyLucene website.

Installation

TurboLucene uses setuptools so, after installing PyLucene separately, installation of TurboLucene is as easy as: 

  easy_install TurboLucene

or: 

  python setup.py install

For more installation options, try: 

  python setup.py --help

Documentation

Here is a list of the available documentation for TurboLucene:

Tutorial
This is the best way to learn TurboLucene.
API Reference
This is the complete API reference. It is generated from the source code directly.
Source Code
Use the source Luke! :-) The source code is very well commented.
SQLAlchemy and Genshi
Sakke Wiik has written a nice article on using TurboLucene with SqlAlchemy and Genshi. Note: this was written for version 0.1. Some small changes are necessary to make it work with 0.2.
Upgrading from 0.1 to 0.2
This document explains how to upgrade from version 0.1.x to version 0.2. Note: this has been updated from the version in the 0.2 source distribution.

Here is a list of documentation that is related to TurboLucene and may also prove useful.

Search Query Syntax
Documentation on Lucene's search query syntax is available at the Lucene web site.
TurboGears Documentation Static Mirror
I have set up a static mirror of the TurboGears documentation wiki (updated nightly). A downloadable archive of it is also available.

Limitations

TurboLucene is still in early stages of development. It has not been optimized, extensively tested, benchmarked or profiled for performance or memory usage. Finally, there are no test cases yet.

The plan is to eliminate these limitations, eventually. Patches and suggestions are welcome! :-)

Please also note that until TurboLucene reaches release 1.0, the API can change in incompatible ways with any revision. To assist in upgrading your project, a migration document will be made for each release that breaks backwards compatibility. Once release 1.0 is reached, then the API should be pretty stable and more attention will be given to backwards compatibility.

License

TurboLucene is licensed under the OSI-approved MIT license.

Bugs

TurboLucene is still in the early stages of development. It very likely has bugs. If you find any, please check to see if there is already a ticket about it, and if not, please login as guest (password: guest) and create a new ticket so it can get fixed. Your support is very much appreciated! :-)

(Login is required because of ticket spam. Sorry.)

Mailing List

Feel free to subscribe to the TurboLucene mailing list. This is the place to ask questions, make suggestions and stay current on TurboLucene development. A searchable archive is also available. Patches, bug reports, bug fixes are all welcome too! :-)

Subversion

You can checkout the latest development version of TurboLucene from the Subversion repository at

http://dev.krys.ca/svn/turbolucene/turbolucene/trunk

or browse the repository here.

Author

The author of TurboLucene is Krys Wilken. Feel free to contact him at krys AT krys DOT ca.

Thanks

Special thanks goes out to all the brilliant and hard working people of the TurboGears and PyLucene projects. Without their tireless efforts, this project would not exist!

Also thanks to everyone in the Open Source and Free Software communities. I really believe the spirit and philosophy of the FLOSS movement will change the world. I am happy to be able to give a little back.

Alternatives