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="#news20110919">23 Jul 2011 - PyLucene 3.4.0-1 available</a>
 156 </li>
 157 <li>
 158 <a href="#news20110723">23 Jul 2011 - PyLucene 3.3-3 available</a>
 159 </li>
 160 <li>
 161 <a href="#news20110609">09 Jun 2011 - PyLucene 3.2.0-1 available</a>
 162 </li>
 163 <li>
 164 <a href="#news20110407">04 Apr 2011 - PyLucene 3.1.0-1 available</a>
 165 </li>
 166 <li>
 167 <a href="#news20101216">16 Dec 2010 - PyLucene 3.0.3-1 and 2.9.4-1 available</a>
 168 </li>
 169 <li>
 170 <a href="#news20100702">02 Jul 2010 - PyLucene 3.0.2-1 and 2.9.3-1 available</a>
 171 </li>
 172 <li>
 173 <a href="#news20100304">03 Mar 2010 - PyLucene 3.0.1-1 and 2.9.2-1 available</a>
 174 </li>
 175 <li>
 176 <a href="#news20091208">08 Dec 2009 - PyLucene 3.0.0-1 available</a>
 177 </li>
 178 <li>
 179 <a href="#news20091110">10 Nov 2009 - PyLucene 2.9.1-1 available</a>
 180 </li>
 181 <li>
 182 <a href="#news20091013">13 Oct 2009 - PyLucene 2.9.0-1 available</a>
 183 </li>
 184 <li>
 185 <a href="#news20090403">03 Apr 2009 - PyLucene 2.4.1-1 available</a>
 186 </li>
 187 <li>
 188 <a href="#news20090108">08 Jan 2009 - PyLucene joins Apache Lucene as a Subproject</a>
 189 </li>
 190 </ul>
 191 </li>
 192 </ul>
 193 </div>
 194
 195 <a name="N1000D"></a><a name="introduction"></a>
 196 <h2 class="boxed">What is PyLucene ?</h2>
 197 <div class="section">
 198 <p>
 199         PyLucene is a <a href="http://www.python.org">Python</a> extension
 200         for accessing
 201         Java <a href="http://lucene.apache.org/java/">Lucene</a>. Its goal
 202         is to allow you to use Lucene's text indexing and searching
 203         capabilities from Python. It is API compatible with the latest
 204         version of Java Lucene, version 3.2 as of June 9th, 2011.
 205       </p>
 206 <p>
 207         PyLucene is not a Lucene port but a Python wrapper around
 208         Java Lucene. PyLucene embeds a Java VM with Lucene into a Python
 209         process. The PyLucene Python extension, a Python module called
 210         <span class="codefrag">lucene</span>, is machine-generated by JCC.
 211       </p>
 212 <p>
 213         PyLucene is built with <a href="jcc/index.html">JCC</a>, a C++
 214         code generator that makes it possible to call into Java classes from
 215         Python via Java's Native Invocation Interface (JNI). Sources for JCC
 216         are included with the PyLucene sources.
 217       </p>
 218 <p>
 219         See <a href="documentation/readme.html">here</a> for more
 220         information and documentation about PyLucene.
 221       </p>
 222 </div>
 223
 224 <a name="N10033"></a><a name="requirements"></a>
 225 <h2 class="boxed">Requirements</h2>
 226 <div class="section">
 227 <p>
 228         PyLucene is supported on Mac OS X, Linux, Solaris and Windows.
 229       </p>
 230 <p>
 231         PyLucene requires Python version 2.x (x &gt;= 3.5) and Java version 1.x
 232         (x &gt;= 4). Building PyLucene requires GNU Make, a recent version
 233         of <a href="http://ant.apache.org">Ant</a> capable of building
 234         Java <a href="http://lucene.apache.org/java/">Lucene</a> and a C++
 235         compiler. Use
 236         of <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>
 237         is recommended.
 238       </p>
 239 <p>
 240         See the JCC <a href="jcc/documentation/install.html">installation
 241         instructions</a> for more information about building JCC from sources.
 242       </p>
 243 <p>
 244         See the PyLucene <a href="documentation/install.html">installation
 245         instructions</a> for more information about building PyLucene from
 246         sources.
 247       </p>
 248 </div>
 249
 250 <a name="N1005A"></a><a name="news"></a>
 251 <h2 class="boxed">News</h2>
 252 <div class="section">
 253 <a name="N10060"></a><a name="news20110919"></a>
 254 <h3 class="boxed">23 Jul 2011 - PyLucene 3.4.0-1 available</h3>
 255 <p>
 256           This release tracks Lucene Core's recent 3.4.0 <a href="http://lucene.apache.org/java/docs/index.html#14+September+2011+-+Lucene+Core+3.4.0">release</a>.
 257         </p>
 258 <p>
 259           See <a href="http://svn.apache.org/repos/asf/lucene/pylucene/tags/pylucene_3_4_0/CHANGES">PyLucene 3.4.0 CHANGES</a> and <a href="http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc/CHANGES">JCC 2.11 CHANGES</a> for details.<br>
 260
 261 </p>
 262 <p>
 263           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 264         </p>
 265 <a name="N10082"></a><a name="news20110723"></a>
 266 <h3 class="boxed">23 Jul 2011 - PyLucene 3.3-3 available</h3>
 267 <p>
 268           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>.
 269         </p>
 270 <p>
 271           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>
 272
 273 </p>
 274 <p>
 275           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 276         </p>
 277 <a name="N100A4"></a><a name="news20110609"></a>
 278 <h3 class="boxed">09 Jun 2011 - PyLucene 3.2.0-1 available</h3>
 279 <p>
 280           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>.
 281         </p>
 282 <p>
 283           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>
 284
 285 </p>
 286 <p>
 287           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 288         </p>
 289 <a name="N100C6"></a><a name="news20110407"></a>
 290 <h3 class="boxed">04 Apr 2011 - PyLucene 3.1.0-1 available</h3>
 291 <p>
 292           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>.
 293         </p>
 294 <p>
 295           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>
 296
 297 </p>
 298 <p>
 299           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 300         </p>
 301 <a name="N100E8"></a><a name="news20101216"></a>
 302 <h3 class="boxed">16 Dec 2010 - PyLucene 3.0.3-1 and 2.9.4-1 available</h3>
 303 <p>
 304           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>.
 305         </p>
 306 <p>
 307           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>
 308           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.
 309         </p>
 310 <p>
 311           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 312         </p>
 313 <a name="N1010E"></a><a name="news20100702"></a>
 314 <h3 class="boxed">02 Jul 2010 - PyLucene 3.0.2-1 and 2.9.3-1 available</h3>
 315 <p>
 316           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>.
 317         </p>
 318 <p>
 319           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>
 320           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.
 321         </p>
 322 <p>
 323           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 324         </p>
 325 <a name="N10134"></a><a name="news20100304"></a>
 326 <h3 class="boxed">03 Mar 2010 - PyLucene 3.0.1-1 and 2.9.2-1 available</h3>
 327 <p>
 328           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>.
 329         </p>
 330 <p>
 331           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>
 332           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.
 333         </p>
 334 <p>
 335           Source distributions are available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 336         </p>
 337 <a name="N1015A"></a><a name="news20091208"></a>
 338 <h3 class="boxed">08 Dec 2009 - PyLucene 3.0.0-1 available</h3>
 339 <p>
 340           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>.
 341         </p>
 342 <p>
 343           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.
 344         </p>
 345 <p>
 346           A source distribution is available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 347         </p>
 348 <a name="N1017A"></a><a name="news20091110"></a>
 349 <h3 class="boxed">10 Nov 2009 - PyLucene 2.9.1-1 available</h3>
 350 <p>
 351           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>.
 352         </p>
 353 <p>
 354           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.
 355         </p>
 356 <p>
 357           A source distribution is available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 358         </p>
 359 <a name="N1019A"></a><a name="news20091013"></a>
 360 <h3 class="boxed">13 Oct 2009 - PyLucene 2.9.0-1 available</h3>
 361 <p>
 362           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>.
 363         </p>
 364 <p>
 365           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.
 366         </p>
 367 <p>
 368           A source distribution is available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 369         </p>
 370 <a name="N101BA"></a><a name="news20090403"></a>
 371 <h3 class="boxed">03 Apr 2009 - PyLucene 2.4.1-1 available</h3>
 372 <p>
 373           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>.
 374         </p>
 375 <p>
 376           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.
 377         </p>
 378 <p>
 379           A source distribution is available <a href="http://www.apache.org/dyn/closer.cgi/lucene/pylucene/">here</a>.
 380         </p>
 381 <a name="N101DA"></a><a name="news20090108"></a>
 382 <h3 class="boxed">08 Jan 2009 - PyLucene joins Apache Lucene as a Subproject</h3>
 383 <p>
 384           The Lucene PMC is pleased to announce the arrival of PyLucene as a
 385           Lucene subproject. PyLucene was previously hosted at the Open
 386           Source Applications Foundation since its inception in early 2004.
 387         </p>
 388 </div>
 389
 390 </div>
 391 <!--+
 392     |end content
 393     +-->
 394 <div class="clearboth">&nbsp;</div>
 395 </div>
 396 <div id="footer">
 397 <!--+
 398     |start bottomstrip
 399     +-->
 400 <div class="lastmodified">
 401 <script type="text/javascript"><!--
 402 document.write("Last Published: " + document.lastModified);
 403 //  --></script>
 404 </div>
 405 <div class="copyright">
 406         Copyright &copy;
 407          2009-2011 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
 408 </div>
 409 <div id="logos"></div>
 410 <!--+
 411     |end bottomstrip
 412     +-->
 413 </div>
 414 </body>
 415 </html>