Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Pythonic search engine based on PyLucene, including a standalone server based on CherryPy.

Project description

Lupyne is a search engine based on PyLucene, the Python extension for accessing Java Lucene. Lucene is a relatively low-level toolkit, and PyLucene wraps it through automatic code generation. So although Java idioms are translated to Python idioms where possible, the resulting interface is far from Pythonic. See ./examples for comparisons with the Lucene API.

Lupyne also provides a RESTful JSON search server, based on CherryPy. Note Solr and Elasticsearch are popular options for Lucene-based search, if no further (Python) customization is needed. So while the server is suitable for production usage, its primary motivation is to be an extensible example.

Not having to initially choose between an embedded library and a server not only provides greater flexibility, it can provide better performance, e.g., batch indexing offline and remote searching live. Additionally only lightweight wrappers with extended behavior are used wherever possible, so falling back to using PyLucene directly is always an option, but should never necessary for performance.


PyLucene requires initializing the VM.

import lucene


Indexes are accessed through an IndexSearcher (read-only), IndexWriter, or the combined Indexer.

from lupyne import engine

searcher = engine.IndexSearcher('index/path')
hits ='text:query')

Run the server.

$ python -m lupyne.server

Read the documentation.


$ pip install lupyne


  • PyLucene >=6.5 (installed separately)
  • six

Optional server extras

  • Python >=3.4
  • CherryPy >=10
  • clients >=0.2


100% branch coverage.

$ pytest [--cov]



  • PyLucene >=6 required
  • Python 3 support
  • client moved to external package


  • 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

Project details

Release history Release notifications

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
lupyne-2.0-py2.py3-none-any.whl (34.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Dec 29, 2017
lupyne-2.0.tar.gz (755.6 kB) Copy SHA256 hash SHA256 Source None Dec 29, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page