1. coady
  2. lupyne

Commits

coady  committed 146f93a

Edited online

  • Participants
  • Parent commits 481d2db
  • Branches default

Comments (0)

Files changed (1)

File Home.wiki

View file
  • Ignore whitespace
-== Welcome ==
+Pythonic extensions to [[http://lucene.apache.org/pylucene/|PyLucene]], including a standalone search server based on [[http://www.cherrypy.org/|CherryPy]].
 
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
+= Project highlights =
 
-=== Wiki features ===
+* The core engine is a high level interface to PyLucene, which is a [[http://www.python.org/|Python]] extension for accessing the popular Java [[http://lucene.apache.org/|Lucene]] search engine.  Lucene has a reputation for being a relatively low-level toolkit, and the goal of PyLucene is to wrap it through automatic code generation.  So although PyLucene transforms Java idioms to Python idioms where possible,  the resulting interface is far from Pythonic.  See [[http://packages.python.org/lupyne/examples.html|examples]] for comparisons with the Lucene API.
 
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
+* A [[http://en.wikipedia.org/wiki/Representational_State_Transfer|RESTful]] [[http://json.org/|JSON]] search server, based on CherryPy.  Many python applications which require better search capabilities are migrating from using conventional client-server databases, whereas Lucene is an embedded search library.  [[http://lucene.apache.org/solr/|Solr]] is a popular option for remote searching and other advanced features, but then any customization or embedded use is coupled to Java and XML.  Using a python web framework instead can provide the best of both worlds, e.g., batch indexing offline and remote searching live.
 
-The wiki itself is actually a mercurial repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
+* A simple client to make interacting with the server as convenient as an [[http://en.wikipedia.org/wiki/Remote_procedure_call|RPC]] interface.  It handles all of the HTTP interactions, with support for compression, json, and connection reuse.
 
-Go ahead and try:
+* Advanced search features:
+** Distributed searching with support for redundancy, partitioning, and sharding.
+** Optimized faceted search.
+** Optimized prefix and range queries.
+** Geospatial support.
+** Spellchecking.
+** Near real-time indexing.
 
-{{{
-$ hg clone https://bitbucket.org/coady/lupyne/wiki
-}}}
+= Documentation =
+  * [[http://packages.python.org/lupyne/|current release]]
+  * [[http://wiki.lupyne.googlecode.com/hg/html/index.html|development trunk]]
 
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
+The project is in production use and the trunk is also stable, with full code coverage tests.  Backwards compatibility, with deprecation warnings, is maintained unless the feature is marked as experimental in Lucene.
 
-=== Syntax highlighting ===
+= Dependencies =
+Lupyne should run anywhere PyLucene does, though its primary testing is on the popular unix variants.
 
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
+  * Python 2.6.5+, 2.7
+  * PyLucene 3.1, 3.2, 3.3, 3.4, 3.5
+  * CherryPy 3.1.2+, 3.2:  only required for server
 
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-    formatter = lambda t: "funky"+t
-    return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+== Changes in 1.1 ==
+ * PyLucene 3.5 supported
+ * PyLucene 3.0 dropped
+ * Storage and retrieval of binary fields
+ * Term query boosting
+ * Server:
+   * Term vectors retrieval
+   * Real-time indexing command-line option