doc/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta content="Apache Forrest" name="Generator">
   6 <meta name="Forrest-version" content="0.8">
   7 <meta name="Forrest-skin-name" content="pelt">
   8 <title>Welcome to PyLucene</title>
   9 <link type="text/css" href="skin/basic.css" rel="stylesheet">
  10 <link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
  11 <link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
  12 <link type="text/css" href="skin/profile.css" rel="stylesheet">
  13 <script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
  14 <link rel="shortcut icon" href="">
  15 </head>
  16 <body onload="init()">
  17 <script type="text/javascript">ndeSetTextSize();</script>
  18 <div id="top">
  19 <!--+
  20     |breadtrail
  21     +-->
  22 <div class="breadtrail">
  23 <a href="http://www.apache.org/">apache</a> &gt; <a href="http://lucene.apache.org/">lucene</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
  24 </div>
  25 <!--+
  26     |header
  27     +-->
  28 <div class="header">
  29 <!--+
  30     |start group logo
  31     +-->
  32 <div class="grouplogo">
  33 <a href="http://lucene.apache.org/"><img class="logoImage" alt="Lucene" src="images/lucene_green_150.gif" title="Lucene Description"></a>
  34 </div>
  35 <!--+
  36     |end group logo
  37     +-->
  38 <!--+
  39     |start Project Logo
  40     +-->
  41 <div class="projectlogoA1">
  42 <a href="http://lucene.apache.org/pylucene/"><img class="logoImage" alt="PyLucene" src="images/project.png" title="PyLucene Description"></a>
  43 </div>
  44 <!--+
  45     |end Project Logo
  46     +-->
  47 <!--+
  48     |start Tabs
  49     +-->
  50 <ul id="tabs">
  51 <li class="current">
  52 <a class="selected" href="index.html">PyLucene</a>
  53 </li>
  54 <li>
  55 <a class="unselected" href="jcc/index.html">JCC</a>
  56 </li>
  57 </ul>
  58 <!--+
  59     |end Tabs
  60     +-->
  61 </div>
  62 </div>
  63 <div id="main">
  64 <div id="publishedStrip">
  65 <!--+
  66     |start Subtabs
  67     +-->
  68 <div id="level2tabs"></div>
  69 <!--+
  70     |end Endtabs
  71     +-->
  72 <script type="text/javascript"><!--
  73 document.write("Last Published: " + document.lastModified);
  74 //  --></script>
  75 </div>
  76 <!--+
  77     |breadtrail
  78     +-->
  79 <div class="breadtrail">
  80
  81              &nbsp;
  82            </div>
  83 <!--+
  84     |start Menu, mainarea
  85     +-->
  86 <!--+
  87     |start Menu
  88     +-->
  89 <div id="menu">
  90 <div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">About</div>
  91 <div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
  92 <div class="menupage">
  93 <div class="menupagetitle">Index</div>
  94 </div>
  95 </div>
  96 <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
  97 <div id="menu_1.2" class="menuitemgroup">
  98 <div class="menuitem">
  99 <a href="documentation/install.html">Installation</a>
 100 </div>
 101 <div class="menuitem">
 102 <a href="documentation/readme.html">Features</a>
 103 </div>
 104 </div>
 105 <div onclick="SwitchMenu('menu_1.3', 'skin/')" id="menu_1.3Title" class="menutitle">Resources</div>
 106 <div id="menu_1.3" class="menuitemgroup">
 107 <div class="menuitem">
 108 <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">Releases</a>
 109 </div>
 110 <div class="menuitem">
 111 <a href="resources/version_control.html">Source Code</a>
 112 </div>
 113 <div class="menuitem">
 114 <a href="resources/mailing_lists.html">Mailing Lists</a>
 115 </div>
 116 <div class="menuitem">
 117 <a href="http://issues.apache.org/jira/browse/PyLucene">Issue Tracking</a>
 118 </div>
 119 </div>
 120 <div id="credit">
 121 <hr>
 122 <a href="http://forrest.apache.org/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a>
 123 </div>
 124 <div id="roundbottom">
 125 <img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
 126 <!--+
 127   |alternative credits
 128   +-->
 129 <div id="credit2"></div>
 130 </div>
 131 <!--+
 132     |end Menu
 133     +-->
 134 <!--+
 135     |start content
 136     +-->
 137 <div id="content">
 138 <div title="Portable Document Format" class="pdflink">
 139 <a class="dida" href="index.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
 140         PDF</a>
 141 </div>
 142 <h1>Welcome to PyLucene</h1>
 143 <div id="minitoc-area">
 144 <ul class="minitoc">
 145 <li>
 146 <a href="#introduction">What is PyLucene ?</a>
 147 </li>
 148 <li>
 149 <a href="#requirements">Requirements</a>
 150 </li>
 151 <li>
 152 <a href="#news">News</a>
 153 <ul class="minitoc">
 154 <li>
 155 <a href="#news20110723">23 Jul 2011 - PyLucene 3.3-3 available</a>
 156 </li>
 157 <li>
 158 <a href="#news20110609">09 Jun 2011 - PyLucene 3.2.0-1 available</a>
 159 </li>
 160 <li>
 161 <a href="#news20110407">04 Apr 2011 - PyLucene 3.1.0-1 available</a>
 162 </li>
 163 <li>
 164 <a href="#news20101216">16 Dec 2010 - PyLucene 3.0.3-1 and 2.9.4-1 available</a>
 165 </li>
 166 <li>
 167 <a href="#news20100702">02 Jul 2010 - PyLucene 3.0.2-1 and 2.9.3-1 available</a>
 168 </li>
 169 <li>
 170 <a href="#news20100304">03 Mar 2010 - PyLucene 3.0.1-1 and 2.9.2-1 available</a>
 171 </li>
 172 <li>
 173 <a href="#news20091208">08 Dec 2009 - PyLucene 3.0.0-1 available</a>
 174 </li>
 175 <li>
 176 <a href="#news20091110">10 Nov 2009 - PyLucene 2.9.1-1 available</a>
 177 </li>
 178 <li>
 179 <a href="#news20091013">13 Oct 2009 - PyLucene 2.9.0-1 available</a>
 180 </li>
 181 <li>
 182 <a href="#news20090403">03 Apr 2009 - PyLucene 2.4.1-1 available</a>
 183 </li>
 184 <li>
 185 <a href="#news20090108">08 Jan 2009 - PyLucene joins Apache Lucene as a Subproject</a>
 186 </li>
 187 </ul>
 188 </li>
 189 </ul>
 190 </div>
 191
 192 <a name="N1000D"></a><a name="introduction"></a>
 193 <h2 class="boxed">What is PyLucene ?</h2>
 194 <div class="section">
 195 <p>
 196         PyLucene is a <a href="http://www.python.org">Python</a> extension
 197         for accessing
 198         Java <a href="http://lucene.apache.org/java/">Lucene</a>. Its goal
 199         is to allow you to use Lucene's text indexing and searching
 200         capabilities from Python. It is API compatible with the latest
 201         version of Java Lucene, version 3.2 as of June 9th, 2011.
 202       </p>
 203 <p>
 204         PyLucene is not a Lucene port but a Python wrapper around
 205         Java Lucene. PyLucene embeds a Java VM with Lucene into a Python
 206         process. The PyLucene Python extension, a Python module called
 207         <span class="codefrag">lucene</span>, is machine-generated by JCC.
 208       </p>
 209 <p>
 210         PyLucene is built with <a href="jcc/index.html">JCC</a>, a C++
 211         code generator that makes it possible to call into Java classes from
 212         Python via Java's Native Invocation Interface (JNI). Sources for JCC
 213         are included with the PyLucene sources.
 214       </p>
 215 <p>
 216         See <a href="documentation/readme.html">here</a> for more
 217         information and documentation about PyLucene.
 218       </p>
 219 </div>
 220
 221 <a name="N10033"></a><a name="requirements"></a>
 222 <h2 class="boxed">Requirements</h2>
 223 <div class="section">
 224 <p>
 225         PyLucene is supported on Mac OS X, Linux, Solaris and Windows.
 226       </p>
 227 <p>
 228         PyLucene requires Python version 2.x (x &gt;= 3.5) and Java version 1.x
 229         (x &gt;= 4). Building PyLucene requires GNU Make, a recent version
 230         of <a href="http://ant.apache.org">Ant</a> capable of building
 231         Java <a href="http://lucene.apache.org/java/">Lucene</a> and a C++
 232         compiler. Use
 233         of <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>
 234         is recommended.
 235       </p>
 236 <p>
 237         See the JCC <a href="jcc/documentation/install.html">installation
 238         instructions</a> for more information about building JCC from sources.
 239       </p>
 240 <p>
 241         See the PyLucene <a href="documentation/install.html">installation
 242         instructions</a> for more information about building PyLucene from
 243         sources.
 244       </p>
 245 </div>
 246
 247 <a name="N1005A"></a><a name="news"></a>
 248 <h2 class="boxed">News</h2>
 249 <div class="section">
 250 <a name="N10060"></a><a name="news20110723"></a>
 251 <h3 class="boxed">23 Jul 2011 - PyLucene 3.3-3 available</h3>
 252 <p>
 253           This release tracks Lucene Core's recent 3.3 <a href="http://lucene.apache.org/#1+July+2011+-+Lucene+Core+3.3+and+Solr+3.3+Available">release</a>.
 254         </p>
 255 <p>
 256           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_3/CHANGES">PyLucene 3.3 CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc/CHANGES">JCC 2.10 CHANGES</a> for details.<br>
 257
 258 </p>
 259 <p>
 260           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 261         </p>
 262 <a name="N10082"></a><a name="news20110609"></a>
 263 <h3 class="boxed">09 Jun 2011 - PyLucene 3.2.0-1 available</h3>
 264 <p>
 265           This release tracks Lucene Core's recent 3.2 <a href="http://lucene.apache.org/java/docs/index.html#4+June+2011+-+Lucene+Core+3.2">release</a>.
 266         </p>
 267 <p>
 268           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_2_0/CHANGES">PyLucene 3.2.0 CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc/CHANGES">JCC 2.9 CHANGES</a> for details.<br>
 269
 270 </p>
 271 <p>
 272           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 273         </p>
 274 <a name="N100A4"></a><a name="news20110407"></a>
 275 <h3 class="boxed">04 Apr 2011 - PyLucene 3.1.0-1 available</h3>
 276 <p>
 277           This release tracks Lucene Core's recent 3.1 <a href="http://lucene.apache.org/java/docs/index.html#31+March+2011+-+Lucene+Core+3.1">release</a>.
 278         </p>
 279 <p>
 280           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_1_0/CHANGES">PyLucene 3.1.0 CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc/CHANGES">JCC 2.8 CHANGES</a> for details.<br>
 281
 282 </p>
 283 <p>
 284           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 285         </p>
 286 <a name="N100C6"></a><a name="news20101216"></a>
 287 <h3 class="boxed">16 Dec 2010 - PyLucene 3.0.3-1 and 2.9.4-1 available</h3>
 288 <p>
 289           These releases track Lucene Java's recent 2.9.4 and 3.0.3 <a href="http://lucene.apache.org/java/docs/index.html#3+December+2010+-+Lucene+Java+3.0.3+and+2.9.4+available">releases</a>.
 290         </p>
 291 <p>
 292           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_0_3/CHANGES">PyLucene 3.0.3 CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc/CHANGES">JCC 2.7 CHANGES</a> for details.<br>
 293           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_9_4/CHANGES">PyLucene 2.9.4 CHANGES</a> for details.
 294         </p>
 295 <p>
 296           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 297         </p>
 298 <a name="N100EC"></a><a name="news20100702"></a>
 299 <h3 class="boxed">02 Jul 2010 - PyLucene 3.0.2-1 and 2.9.3-1 available</h3>
 300 <p>
 301           These releases track Lucene Java's recent 2.9.3 and 3.0.2 <a href="http://lucene.apache.org/java/docs/index.html#18+June+2010+-+Lucene+Java+3.0.2+and+2.9.3+available">releases</a>.
 302         </p>
 303 <p>
 304           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_0_2/CHANGES">PyLucene 3.0.2 CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_0_2/jcc/CHANGES">JCC 2.6 CHANGES</a> for details.<br>
 305           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_9_3/CHANGES">PyLucene 2.9.3 CHANGES</a> for details.
 306         </p>
 307 <p>
 308           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 309         </p>
 310 <a name="N10112"></a><a name="news20100304"></a>
 311 <h3 class="boxed">03 Mar 2010 - PyLucene 3.0.1-1 and 2.9.2-1 available</h3>
 312 <p>
 313           These releases track Lucene Java's recent 2.9.2 and 3.0.1 <a href="http://lucene.apache.org/java/docs/index.html#26+February+2010+-+Lucene+Java+3.0.1+and+2.9.2+available">releases</a>.
 314         </p>
 315 <p>
 316           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_0_1/CHANGES">PyLucene 3.0.1 CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_0_1/jcc/CHANGES">JCC 2.5.1 CHANGES</a> for details.<br>
 317           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_9_2/CHANGES">PyLucene 2.9.2 CHANGES</a> for details.
 318         </p>
 319 <p>
 320           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 321         </p>
 322 <a name="N10138"></a><a name="news20091208"></a>
 323 <h3 class="boxed">08 Dec 2009 - PyLucene 3.0.0-1 available</h3>
 324 <p>
 325           This release tracks Lucene Java's recent 3.0.0 <a href="http://lucene.apache.org/java/docs/index.html#25+November+2009+-+Lucene+Java+3.0.0+available">release</a>.
 326         </p>
 327 <p>
 328           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_0_0/CHANGES">PyLucene CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_0_0/jcc/CHANGES">JCC CHANGES</a> for details.
 329         </p>
 330 <p>
 331           A source distribution is available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 332         </p>
 333 <a name="N10158"></a><a name="news20091110"></a>
 334 <h3 class="boxed">10 Nov 2009 - PyLucene 2.9.1-1 available</h3>
 335 <p>
 336           This release tracks Lucene Java's recent 2.9.1 <a href="http://lucene.apache.org/java/docs/index.html#6+November+2009+-+Lucene+Java+2.9.1+available">release</a>.
 337         </p>
 338 <p>
 339           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_9_1/CHANGES">PyLucene CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_9_1/jcc/CHANGES">JCC CHANGES</a> for details.
 340         </p>
 341 <p>
 342           A source distribution is available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 343         </p>
 344 <a name="N10178"></a><a name="news20091013"></a>
 345 <h3 class="boxed">13 Oct 2009 - PyLucene 2.9.0-1 available</h3>
 346 <p>
 347           This release tracks Lucene Java's recent 2.9.0 <a href="http://lucene.apache.org/java/docs/index.html#25+September+2009+-+Lucene+Java+2.9.0+available">release</a>.
 348         </p>
 349 <p>
 350           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_9_0/CHANGES">PyLucene CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_9_0/jcc/CHANGES">JCC CHANGES</a> for details.
 351         </p>
 352 <p>
 353           A source distribution is available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 354         </p>
 355 <a name="N10198"></a><a name="news20090403"></a>
 356 <h3 class="boxed">03 Apr 2009 - PyLucene 2.4.1-1 available</h3>
 357 <p>
 358           This release tracks Lucene Java's recent 2.4.1 <a href="http://lucene.apache.org/java/docs/index.html#9+March+2009+-+Lucene+Java+2.4.1+available">release</a>.
 359         </p>
 360 <p>
 361           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_4_1/CHANGES">PyLucene CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_2_4_1/jcc/CHANGES">JCC CHANGES</a> for details.
 362         </p>
 363 <p>
 364           A source distribution is available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 365         </p>
 366 <a name="N101B8"></a><a name="news20090108"></a>
 367 <h3 class="boxed">08 Jan 2009 - PyLucene joins Apache Lucene as a Subproject</h3>
 368 <p>
 369           The Lucene PMC is pleased to announce the arrival of PyLucene as a
 370           Lucene subproject. PyLucene was previously hosted at the Open
 371           Source Applications Foundation since its inception in early 2004.
 372         </p>
 373 </div>
 374
 375 </div>
 376 <!--+
 377     |end content
 378     +-->
 379 <div class="clearboth">&nbsp;</div>
 380 </div>
 381 <div id="footer">
 382 <!--+
 383     |start bottomstrip
 384     +-->
 385 <div class="lastmodified">
 386 <script type="text/javascript"><!--
 387 document.write("Last Published: " + document.lastModified);
 388 //  --></script>
 389 </div>
 390 <div class="copyright">
 391         Copyright &copy;
 392          2009-2011 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
 393 </div>
 394 <div id="logos"></div>
 395 <!--+
 396     |end bottomstrip
 397     +-->
 398 </div>
 399 </body>
 400 </html>