lupyne /

Filename Size Date modified Message
48 B
874 B
576 B
136 B
533 B
3.0 KB
162 B
1.3 KB
260 B

About Lupyne

The core engine is a high level interface to PyLucene, which is a Python extension for accessing the popular Java 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 ./examples for comparisons with the Lucene API.

A RESTful 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. Solr and Elasticsearch are popular options for remote searching and advanced features, but then any customization beyond the REST API is difficult and coupled to Java. Using a python web framework instead can provide the best of both worlds, e.g., batch indexing offline and remote searching live.

A simple client to make interacting with the server as convenient as an RPC interface. It handles all of the HTTP interactions, with support for compression, json, and connection reuse.

Advanced search features:

  • Automatic updating and syncing to support replication.
  • Optimized faceted and grouped search.
  • Optimized prefix and range queries.
  • Geospatial support.
  • Spellchecking.
  • Near real-time indexing.

See documentation for example usage.


$ pip install lupyne


  • Python 2.7, 3.6
  • PyLucene 6+ (installed separately)
  • six

Optional server extras

  • CherryPy 10+
  • clients 0.2+


100% branch coverage.

$ pytest [--cov]



  • PyLucene 6 required
  • Python 3 support


  • Python 2.6 dropped
  • PyLucene 4.8 and 4.9 dropped
  • IndexWriter implements context manager
  • Server DocValues updated via patch method
  • Spatial tile search optimized


  • PyLucene 4.10 supported
  • PyLucene 4.6 and 4.7 dropped
  • Comparator iteration optimized
  • Support for string based FieldCacheRangeFilters