Skills

A skill is a package of structured files that teaches an AI coding agent how to work with a specific tool or framework. The skill below was generated by Great Docs from this project’s documentation. Install it in your agent and it will be able to run commands, edit configuration, write content, and troubleshoot problems without step-by-step guidance from you.

Any agent — install with npx:

npx skills add https://coady.github.io/lupyne/

Codex / OpenCode

Tell the agent:
Fetch the skill file at https://coady.github.io/lupyne/skill.md and follow the instructions.

Manual — download the skill file:

curl -O https://coady.github.io/lupyne/skill.md

Or browse the SKILL.md file.

SKILL.md

---
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