---
name: lupyne
description: >
  Pythonic search engine based on PyLucene. Use when writing Python code that uses the lupyne package.
license: Apache-2.0
compatibility: Requires Python >=3.11.
---

# lupyne

Pythonic search engine based on PyLucene.

## Installation

```bash
pip install lupyne
```

## API overview

### Engine

Pythonic wrapper around PyLucene.

- `engine.Analyzer`
- `engine.TokenFilter`
- `engine.DateTimeField`
- `engine.Document`
- `engine.Field`
- `engine.NestedField`
- `engine.ShapeField`
- `engine.Indexer`
- `engine.IndexSearcher`
- `engine.IndexWriter`
- `engine.MultiSearcher`
- `engine.Query`

## Resources

- [Full documentation](https://coady.github.io/lupyne/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs