# Welcome to tantivy-py

tantivy-py is a wrapper for the [tantivy](https://github.com/quickwit-oss/tantivy) full-text search engine, which is inspired by Apache Lucene. 

tantivy-py is [licensed](https://github.com/quickwit-oss/tantivy-py/blob/master/LICENSE) under the [MIT License](https://www.tldrlegal.com/license/mit-license).

## Important links

- [tantivy-py code repository](https://github.com/quickwit-oss/tantivy-py)
- [tantivy code repository](https://github.com/quickwit-oss/tantivy)
- [tantivy Documentation](https://docs.rs/crate/tantivy/latest)
- [tantivy query language](https://docs.rs/tantivy/latest/tantivy/query/struct.QueryParser.html#method.parse_query)

## How to use this documentation

This documentation uses the [Diátaxis](https://diataxis.fr/) framework. The following sections are clearly separated:

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