Welcome to tantivy-py

tantivy-py is a wrapper for the tantivy full-text search engine, which is inspired by Apache Lucene.

tantivy-py is licensed under the MIT License.

Important links

• tantivy-py code repository
• tantivy code repository
• tantivy Documentation
• tantivy query language

How to use this documentation

This documentation uses the Diátaxis framework. The following sections are clearly separated:

• Tutorials: when you want to learn
• How-to Guides: when need to accomplish a task
• Explanation: when you need a broader understanding and the thinking behind why certain things are set up in a particular way.
• Reference: when you need precise, detailed information