| 1 |
.. Revision: $Id$ |
|---|
| 2 |
|
|---|
| 3 |
TurboLucene |
|---|
| 4 |
=========== |
|---|
| 5 |
|
|---|
| 6 |
About |
|---|
| 7 |
----- |
|---|
| 8 |
|
|---|
| 9 |
TurboLucene is a library that allows TurboGears_ applications to use PyLucene_ |
|---|
| 10 |
for full text searching. It features a simple interface and takes care of all |
|---|
| 11 |
the nasty threading issues that exist between PyLucene and CherryPy_ (which is |
|---|
| 12 |
used by TurboGears). |
|---|
| 13 |
|
|---|
| 14 |
It now also features multi-lingual support for *Czech*, *Danish*, *German*, |
|---|
| 15 |
*Greek*, *English*, *Spanish*, *Finnish*, *French*, *Italian*, *Japanese*, |
|---|
| 16 |
*Korean*, *Dutch*, *Norwegian*, *Portuguese*, *Brazilian*, *Russian*, |
|---|
| 17 |
*Swedish*, and *Chinese*, including pre-configured stopwords for most |
|---|
| 18 |
languages. |
|---|
| 19 |
|
|---|
| 20 |
.. _TurboGears: http://turbogears.org/ |
|---|
| 21 |
.. _PyLucene: http://pylucene.osafoundation.org/ |
|---|
| 22 |
.. _CherryPy: http://cherrypy.org |
|---|
| 23 |
|
|---|
| 24 |
|
|---|
| 25 |
Requirements |
|---|
| 26 |
------------ |
|---|
| 27 |
|
|---|
| 28 |
* PyLucene 2.0.0 or better |
|---|
| 29 |
* TurboGears 1.0 or better |
|---|
| 30 |
|
|---|
| 31 |
Thanks to setuptools, TurboGears and it's dependencies will be installed |
|---|
| 32 |
automatically, if necessary. However, PyLucene must be downloaded and |
|---|
| 33 |
installed manually. |
|---|
| 34 |
|
|---|
| 35 |
TurboLucene is not very demanding and may work with earlier versions of both |
|---|
| 36 |
PyLucene and TurboGears, but other versions have not been tested. |
|---|
| 37 |
|
|---|
| 38 |
|
|---|
| 39 |
Installation |
|---|
| 40 |
------------ |
|---|
| 41 |
|
|---|
| 42 |
TurboLucene uses setuptools, so installation is as easy as:: |
|---|
| 43 |
|
|---|
| 44 |
easy_install TurboLucene |
|---|
| 45 |
|
|---|
| 46 |
or:: |
|---|
| 47 |
|
|---|
| 48 |
python setup.py install |
|---|
| 49 |
|
|---|
| 50 |
For more installation options, try:: |
|---|
| 51 |
|
|---|
| 52 |
python setup.py --help |
|---|
| 53 |
|
|---|
| 54 |
|
|---|
| 55 |
Manual Download |
|---|
| 56 |
--------------- |
|---|
| 57 |
|
|---|
| 58 |
The latest version can always be downloaded at http://dev.krys.ca/turbolucene. |
|---|
| 59 |
|
|---|
| 60 |
|
|---|
| 61 |
Documentation |
|---|
| 62 |
------------- |
|---|
| 63 |
|
|---|
| 64 |
Documentation for TurboLucene can be found at: |
|---|
| 65 |
|
|---|
| 66 |
http://dev.krys.ca/turbolucene/#Documentation |
|---|
| 67 |
|
|---|
| 68 |
|
|---|
| 69 |
Limitations |
|---|
| 70 |
----------- |
|---|
| 71 |
|
|---|
| 72 |
TurboLucene is still in early stages of development. It has not been |
|---|
| 73 |
optimised, extensively tested, benchmarked or profiled for performance or |
|---|
| 74 |
memory usage. Finally, there are no test cases yet. |
|---|
| 75 |
|
|---|
| 76 |
The plan is to eliminate these limitations, eventually. |
|---|
| 77 |
|
|---|
| 78 |
Patches and suggestions are welcome! :-) |
|---|
| 79 |
|
|---|
| 80 |
|
|---|
| 81 |
License |
|---|
| 82 |
------- |
|---|
| 83 |
|
|---|
| 84 |
TurboLucene is licensed under the MIT license. See the LICENSE file for |
|---|
| 85 |
details. |
|---|
| 86 |
|
|---|
| 87 |
|
|---|
| 88 |
Contact |
|---|
| 89 |
------- |
|---|
| 90 |
|
|---|
| 91 |
TurboLucene's web site is: |
|---|
| 92 |
|
|---|
| 93 |
http://dev.krys.ca/turbolucene |
|---|
| 94 |
|
|---|
| 95 |
You can find more documentation there. It is also where you can submit bugs. |
|---|
| 96 |
TurboLucene mailing list information can be found at: |
|---|
| 97 |
|
|---|
| 98 |
http://dev.krys.ca/turbolucene/#MailingList |
|---|
| 99 |
|
|---|
| 100 |
The mailing list is the place to ask any questions or make suggestions. |
|---|
| 101 |
Patches, bug reports, bug fixes and suggestions are all welcome! :-) |
|---|
| 102 |
|
|---|
| 103 |
|
|---|
| 104 |
Author |
|---|
| 105 |
====== |
|---|
| 106 |
|
|---|
| 107 |
The author of TurboLucene is Krys Wilken. Feel free to contact him at krys AT |
|---|
| 108 |
krys DOT ca. |
|---|
| 109 |
|
|---|
| 110 |
|
|---|
| 111 |
Thanks |
|---|
| 112 |
====== |
|---|
| 113 |
|
|---|
| 114 |
Special thanks goes out to all the brilliant and hard working people of the |
|---|
| 115 |
TurboGears and PyLucene projects. Without their tireless efforts, this project |
|---|
| 116 |
would not exist! |
|---|
| 117 |
|
|---|
| 118 |
Also thanks to everyone in the Open Source and Free Software communities. I |
|---|
| 119 |
really believe the spirit and philosophy of the FLOSS movement will change the |
|---|
| 120 |
world. I am happy to be able to give a little back. |
|---|
